List PDF Templates

GET

/api/pdf-reports/templates

List all PDF templates available to the current organization (org-specific + global). Pagination is opt-in: pass page[size] and/or page[number] (zero-based) to receive a slice with meta.page, meta.pageSize and links.next. Without them the full list is returned.

Authorizations

ApiKeyAuth

API key for authentication. Get your API key from the dashboard.

Type

API Key (header: X-Api-Key)

Parameters

Query Parameters

page[size]

Templates per page (default 10, max 100). Enables pagination.

Type

integer

Minimum

1

Maximum

100

page[number]

Zero-based page number (default 0). Enables pagination.

Type

integer

Minimum

0

Responses

List of PDF templates

Content-Type

application/vnd.api+json

{

  

"data": [

  

  

{

  

  

  

"type": "pdf-template",

  

  

  

"id": "string",

  

  

  

"attributes": {

  

  

  

  

"organizationId": "string",

  

  

  

  

"name": "string",

  

  

  

  

"description": "string",

  

  

  

  

"reportType": "string",

  

  

  

  

"editorConfig": {

  

  

  

  

  

"additionalProperties": null

  

  

  

  

},

  

  

  

  

"pageSettings": {

  

  

  

  

  

"additionalProperties": null

  

  

  

  

},

  

  

  

  

"customCss": "string",

  

  

  

  

"isDefault": true,

  

  

  

  

"isActive": true,

  

  

  

  

"version": 0,

  

  

  

  

"createdAt": "string",

  

  

  

  

"updatedAt": "string"

  

  

  

}

  

  

}

  

],

  

"meta": {

  

  

"count": 0,

  

  

"total": 0,

  

  

"page": 0,

  

  

"pageSize": 0

  

},

  

"links": {

  

  

"next": "string"

  

}

}

GET

/api/pdf-reports/templates

Playground

Authorization

ApiKeyAuth

Variables

Key

Value

page[size]

page[number]

Samples

Powered by VitePress OpenAPI