Retrieve a document
Retrieves the document identified by the specified slug.
Authorizations
API key used to authenticate and authorise every request.
Include it in the x-api-key header.
Headers
Defines the response type.
application/vnd.Creative Force.v2.3+json, application/vnd.Creative Force.v2.3+xml 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.
all, ar_AR, bg_BG, bn_IN, ca_ES, cs_CZ, cy_GB, da_DK, de_DE, en_GB, en_US, el_GR, es_NN, es_LA, et_EE, fa_NN, fi_FI, fr_FR, fr_CA, he_IL, hi_IN, hr_HR, hu_HU, hy_AM, it_IT, ja_JP, ko_KR, lt_LT, ms_MY, nl_NL, nb_NO, pl_PL, pt_BR, ro_RO, ru_RU, sk_SK, sl_SI, sq_AL, sr_RS, sv_SE, sw_NN, th_TH, tr_TR, uk_UA, vi_VN, zh_CN, zh_HK Path Parameters
Slug of the document.
^[A-Za-z]{8}$Response
Document retrieved.
Document generated from a document template and attached to an application, allocation, or user.
Carries the generated file, its translated name and description, the user who created it, and the resource it is attached to.
Allocation the document is attached to.
Empty array when the document is not attached to an allocation.
Application the document is attached to.
Empty array when the document is not attached to an application.
Date and time when the document was created.
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.
Generated document file.
File format of the generated document.
PDF, Word 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.
Specifies whether the document is shared with the applicant.
URL-safe identifier of the document.
User who created the document.
Empty array when no user is attached.