Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Read document

GET
/api/v1/legal/{kind}
curl --request GET \
  --url https://example.com/api/v1/legal/terms

Public: the latest published version, in lang when it exists.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
kind
required
LegalDocumentKind

The legal documents a deployment’s operator publishes for its users (Platform), accepted together at signup.

string
Allowed values: terms privacy

Query Parameters

Section titled “Query Parameters”
lang
Any of:
string
<= 8 characters

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
LegalDocumentRead
object
content
required
Content
string
kind
required
LegalDocumentKind

The legal documents a deployment’s operator publishes for its users (Platform), accepted together at signup.

string
Allowed values: terms privacy
language
required
Language
string
published_at
required
Published At
string format: date-time
requested_language_available
required
Requested Language Available
boolean
version
required
Version
integer

Example 

{
  "kind": "terms"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}