Skip to main content
GET
Get a template

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

id
string
required

Template ID

Response

OK

category
string

Report family this template belongs to, lower-case; empty on a template stored before categories existed

Example:

"cadoc"

createdAt
string<date-time>

Template creation timestamp in UTC

Example:

"2021-01-01T00:00:00Z"

description
string

Human-readable template description

Example:

"Monthly financial report"

fileName
string

Stored template filename

Example:

"0196159b-4f26-7300-b3d9-f4f68a7c85f3_1744119295.tpl"

id
string

Unique template identifier

Example:

"00000000-0000-0000-0000-000000000000"

outputFormat
string

Format generated from this template

Example:

"HTML"

parameters
object[] | null

Generation parameters this template declares; a report request must answer each required one. Empty when the template declares none

updatedAt
string<date-time>

Most recent template update timestamp in UTC

Example:

"2021-01-01T00:00:00Z"