Template API

Get template details

Returns details for the template identified by templateId, including its content, sample data, PDF parameters, and metadata for the active draft and latest published version. If an active draft exists, the content, sample data, and PDF parameters come from it. Otherwise, they come from the latest published version.

get/v1/templates/{templateId}

Request

  • Base URL: https://api.pdfbolt.com
  • URL: https://api.pdfbolt.com/v1/templates/{templateId}
  • Auth: API key in header PERSONAL-ACCESS-TOKEN

Path parameters

templateIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

UUID of a PDFBolt template.

Response

Template details returned successfully.

idstring uuid required

Unique template identifier.

namestring required

Human-readable template name.

descriptionstring required

Template description. An empty string means no description was provided.

templateEngine'HANDLEBARS' required

Template engine used to evaluate template content.

hasDraftboolean required

Whether the template currently has an active draft.

contentstring byte required

Base64-encoded complete UTF-8 HTML document with optional Handlebars placeholders.

sampleDataobject required

Sample data saved with the same version as content.

Changes

No recorded changes to this operation across all 1 revision of this API.