Skip to navigation

Read a stored PDF template

Returns a template of the organization of the API key or a system template, inactive ones included, with the metadata of its images. A template of another organization is 404. Requires an API key with pdf:template:read and purpose user; session keys get 403 SESSION_KEY_FORBIDDEN. Not metered.

Authentication

AuthorizationBearer

API Key authentication. Use sk_live_* for production or sk_test_* for testing.

Path parameters

idstringRequiredformat: "uuid"
Template id

Response

The template
idstringformat: "uuid"

Template id — use it as templateId in POST /pdf/generate.

organizationIdstring
namestring
descriptionstring or null
documentTypestring
versionstring
templatemap from strings to any
The stored BlockTemplate.
sampleDatamap from strings to any or null
pageSettingsmap from strings to any or null
isDefaultboolean or null
isActiveboolean or null
countryCodestring or null
isSystemboolean
createdAtdatetime
createdBystring

api-key:<key name> for templates stored through this API.

updatedAtdatetime
updatedBystring
imageslist of objects
Images of the template, metadata only.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
413
Content Too Large Error
500
Internal Server Error