List documents

GET

/api/v1/legal

const url = 'https://example.com/api/v1/legal';
const options = {method: 'GET'};

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/legal

Public: the register screen reads it before anyone signs in.

Responses

200

Successful Response

application/json

LegalDocumentListResponse

object

items

required

Items

Array<object>

LegalDocumentSummary

The latest published version of a document, without its text.

object

kind

required

LegalDocumentKind

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

string

Allowed values: terms privacy

languages

required

Languages

Array<string>

published_at

required

Published At

string format: date-time

version

required

Version

integer

Example

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