Skip to main content
GET
Get template

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

Unique template key.

Example:

"invoice-template"

Query Parameters

draft
boolean
default:false

When true, targets the draft version of a template. Defaults to published.

Response

Template retrieved successfully. The example below shows a fully configured invoice template: a DOCX source rendered to PDF, a templated output filename, and one signatory whose details are resolved from the trigger payload.

body
object

A document template. The source DOCX is rendered with angular expression parser when the template is triggered; output controls where and in what format the rendered file is written.

metadata
object | null

Optional data-point metadata about the aggregate.