v50

latestOpenAPI 3.1.0Creative Force Client Subscription Termsraw.githubusercontent.com2026-07-137852387.4 KB

Documents

Retrieve a document

Retrieves the document identified by the specified slug.

get/document/{document_slug}

Path parameters

document_slugstring required

Slug of the document.

Headers

Accept'application/vnd.Creative Force.v2.3+json' | 'application/vnd.Creative Force.v2.3+xml' required

Defines the response type.

x-api-languagestring[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Response

Document retrieved.

created_atstring date-time

Date and time when the document was created.

descriptionobject

Description of the document, inherited from the document template.

Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.

file_type'PDF' | 'Word'

File format of the generated document.

nameobject

Name of the document.

Map keyed by locale code (for example, en_GB or fr_FR). Keys are drawn from the languages enabled on the account. Values are the translated string.

shared_with_userboolean

Specifies whether the document is shared with the entrant.

slugstring

URL-safe identifier of the document.

Example response

{
  "allocation": [],
  "created_at": "2025-01-15T09:00:00Z",
  "description": {
    "en_GB": ""
  },
  "entry": {
    "slug": "AbCdEfGh",
    "link": "https://api.au.cr4ce.com/entry/AbCdEfGh",
    "title": "Sustainable Cities Initiative"
  },
  "file": {
    "token": "IjKlMnOpQrStUvWx",
    "link": "https://api.au.cr4ce.com/file/IjKlMnOpQrStUvWx",
    "name": "certificate.pdf",
    "download": "https://files.au.cr4ce.com/file/IjKlMnOpQrStUvWx/certificate.pdf?Expires=1781485359&Signature=REDACTED&Key-Pair-Id=REDACTED"
  },
  "file_type": "PDF",
  "name": {
    "en_GB": "Certificate of entry"
  },
  "shared_with_user": false,
  "slug": "QrStUvWx",
  "user": {
    "slug": "YzAbCdEf",
    "link": "https://api.au.cr4ce.com/user/YzAbCdEf",
    "name": "Rachel Martin",
    "first_name": "Rachel",
    "last_name": "Martin"
  }
}