Company logoTrust Center Documentation
API v1 ReferenceDocumentsId

Get document details

Read the document for the selected locale. The `locale` query value takes precedence over the `x-locale` header. The tenant default locale is used when…

GET
/api/v1/documents/{id}

Read the document for the selected locale. The locale query value takes precedence over the x-locale header. The tenant default locale is used when neither is supplied.

When versioning is false, return base content and ignore retained active or published versions for content selection. active_version can still hold a retained version UUID; clients must use versioning as the controlling signal.

When versioning is true, return content in this order:

  1. Active published version
  2. Newest published version
  3. Base content when no published version exists

Set version=base to read raw base content. UUID version reads use the exact-version endpoint, not this query value.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Document ID

Formatuuid

Query Parameters

version?"base"

Read raw base content. This is the only explicit v1 value.

Value in

  • "base"
locale?string

Selected locale. This value takes precedence over x-locale. An invalid or disabled explicit value returns 400.

Header Parameters

x-locale?string

Selected locale when the locale query value is not supplied. The tenant default locale is the fallback only when both locale inputs are absent. An invalid or disabled explicit value returns 400.

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/documents/550e8400-e29b-41d4-a716-446655440000"

{  "document": {    "id": "550e8400-e29b-41d4-a716-446655440000",    "title": "Privacy Policy - approved version",    "description_markdown": "# Privacy Policy\n\nUse **approved** controls.",    "versioning": true,    "_version": {      "id": "b9db1e63-3c9c-4b37-a1b1-29d9a7df0a46",      "key": "00000000-0000-4000-8000-000000000000",      "name": "Approved policy",      "status": "published",      "is_active": true    }  },  "active_version": "b9db1e63-3c9c-4b37-a1b1-29d9a7df0a46"}

How is this guide?