Appearance
Read template
GET
/api/v1/templates/{id}
Returns the template metadata, the stored code and styles, the example context (parsed JSON value), the block tree (null in code mode), and the folder it is filed under (null at the root). Reads the published copy (what /render serves) unless stage=draft asks for work in progress.
Authorizations
ApiKeyAuth
Long-lived account credential. Create one from the dashboard.
Type
API Key (header: x-api-key)
or
BearerAuth
Short-lived presigned token scoped to a single template (minted via /presigned-url).
Type
HTTP (bearer)
Parameters
Path Parameters
id*
Type
Requiredstring
Example
"bonipyZlnbwtYVSzQO3AA"Query Parameters
stage
Which copy to read. published (the default) is what renders; draft is work in progress, and falls back to the published copy when there is none.
Type
string
Valid values
"draft""published"Example
"draft"Responses
Template found.
application/json
Structural JSON value: object or array. Scalars and null are rejected.
Subject line as stored (Handlebars), or null when none is set.
Where the template is filed (id + normalized path), or null at the root.
Problems found in the template. Advisory rather than fatal: a template that renders can still carry warnings, while an error severity is one that will not.