GET
/
v1
/
templates
List Templates
curl --request GET \
  --url https://smart-templates.sandbox.midaz.io/v1/templates
{
"items": [
{
"id": "0196b193-0dc6-7a30-abb5-4f1ce5e8f829",
"outputFormat": "html",
"description": "Statements",
"filename": "0196b193-0dc6-7a30-abb5-4f1ce5e8f829.tpl",
"createdAt": "2025-05-08T20:25:26.726Z",
"updatedAt": "2025-05-08T20:25:26.726Z",
"deletedAt": null
},
{
"id": "0196b1a4-a154-7adc-81c2-45fb1393c30d",
"outputFormat": "txt",
"description": "CNAB",
"filename": "0196b1a4-a154-7adc-81c2-45fb1393c30d.tpl",
"createdAt": "2025-05-08T20:44:38.612Z",
"updatedAt": "2025-05-08T20:44:38.612Z",
"deletedAt": null
},
{
"id": "0196b1a7-ceb5-7987-b465-261ea8390f33",
"outputFormat": "txt",
"description": "Test",
"filename": "0196b1a7-ceb5-7987-b465-261ea8390f33.tpl",
"createdAt": "2025-05-08T20:48:06.837Z",
"updatedAt": "2025-05-08T20:48:06.837Z",
"deletedAt": "2025-05-08T20:48:06.837Z"
},
{
"id": "0196b1d2-399c-7aff-8941-3ea99d1525d4",
"outputFormat": "txt",
"description": "Fees",
"filename": "0196b1d2-399c-7aff-8941-3ea99d1525d4.tpl",
"createdAt": "2025-05-08T21:34:26.716Z",
"updatedAt": "2025-05-08T21:50:24.844Z",
"deletedAt": null
},
{
"id": "0196b264-24d4-7e0b-ad5c-9028cc05138d",
"outputFormat": "txt",
"description": "Test 3",
"filename": "0196b264-24d4-7e0b-ad5c-9028cc05138d.tpl",
"createdAt": "2025-05-09T00:13:49.652Z",
"updatedAt": "2025-05-09T00:13:49.652Z",
"deletedAt": null
},
{
"id": "0196b270-a315-7137-9408-3f16af2685e1",
"outputFormat": "txt",
"description": "Organization Ledgers",
"filename": "0196b270-a315-7137-9408-3f16af2685e1.tpl",
"createdAt": "2025-05-09T00:27:28.405Z",
"updatedAt": "2025-05-09T00:27:28.405Z",
"deletedAt": null
}
],
"page": 1,
"limit": 10,
"total": 6
}

Headers

Authorization
string

The authorization token. Important: This header is required if your environment has the Acces Manager plugin enabled.

X-Organization-id
string

The unique identifier of the Organization associated with the request.

Query Parameters

page
string

The number of the page that you want to retrieve.

limit
string

Maximum number of items returned per page.

outputFormat
string

The format of the generated output (e.g., HTML, CSV, PDF, TXT, XML).

description
string

Briefly describes what the template is for or what it contains.

createdAt
string

Timestamp indicating when the template was created.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

id
string

Unique ID that identifies the template (UUID format).

outputFormat
string

The format of the generated output (e.g., HTML, CSV, PDF, TXT, XML).

description
string

Briefly describes what the template is for or what it contains.

fileName
string

The name of the template file as stored in the system. Follows the <template_id>.tpl format.

createdAt
string

Timestamp indicating when the template was created.

updatedAt
string

Timestamp indicating the last time the template was updated.

deletedAt
string

Timestamp indicating when the template was soft deleted.