Skip to main content
GET
List templates

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

output_format
string

Template output format; outputFormat is also accepted

description
string

Case-insensitive substring match on the template description

created_at
string<date>

Creation date in YYYY-MM-DD format; createdAt is also accepted

data_source_name
string

Returns only templates whose mapped fields reference this data source name; dataSourceName is also accepted. Held to the same grammar every registrable data source name is held to, ^[a-zA-Z0-9_-]{1,100}$ — letters, digits, underscores and hyphens only, at most 100 characters. A dotted, operator-shaped, empty, or over-long value is refused as an invalid query parameter.

category
string

Returns only templates filed under this report family. The value is normalised the same way it is on write, so the case you type does not matter: category=CADOC and category=cadoc return the same templates. A blank value is no filter at all; the words 'null' and 'nil' are family names like any other.

has_category
string

Tri-state. Omit it to narrow by nothing. has_category=false returns only templates with NO family — both those stored before the field existed and those carrying an empty one — which is how the templates still needing a family are found; combine it with limit=1 and read total to count them. has_category=true is the exact complement. The only accepted values are true and false; anything else is refused as an invalid query parameter.

sort_order
enum<string>
default:desc

Sort order by creation time; sortOrder is also accepted

Available options:
asc,
desc
limit
integer
default:10

Page size; parsed by the domain query validator

page
integer
default:1

Page number; parsed by the domain query validator

Response

OK

items
object[] | null

Templates in the current page

Example:
limit
integer<int64>

Maximum number of templates in the page

Example:

10

page
integer<int64>

Current page number

Example:

1

total
integer<int64>

Total number of matching templates

Example:

10