Admin list

GET

/api/v1/instance/legal

const url = 'https://example.com/api/v1/instance/legal';
const options = {method: 'GET', headers: {cookie: 'ttx_access_token=<ttx_access_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/instance/legal \
  --cookie ttx_access_token=<ttx_access_token>

Every legal document with its draft and published versions.

Authorizations

sessionCookie

Responses

200

Successful Response

application/json

LegalDocumentAdminListResponse

object

items

required

Items

Array<object>

LegalDocumentAdminRead

Platform’s view of one document: the working draft, whether it differs from what’s published, and every published version.

object

draft

required

LegalDraftRead

object

content

required

Content

object

key

additional properties

string

updated_at

required

Any of:

string
null

string format: date-time

has_unpublished_changes

required

Has Unpublished Changes

boolean

kind

required

LegalDocumentKind

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

string

Allowed values: terms privacy

versions

required

Versions

Array<object>

LegalVersionSummary

object

languages

required

Languages

Array<string>

published_at

required

Published At

string format: date-time

published_by

required

Any of:

string
null

string

requires_acceptance

required

Requires Acceptance

boolean

version

required

Version

integer

Example

{
  "items": [
    {
      "kind": "terms"
    }
  ]
}