Pular para o conteúdo principal
GET
/
v1
/
templates
Listar Templates
curl --request GET \
  --url https://reporter.sandbox.lerian.net/v1/templates \
  --header 'X-Organization-id: <x-organization-id>'
{
  "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"
    },
    {
      "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"
    }
  ],
  "page": 1,
  "limit": 10,
  "total": 6
}

Cabeçalhos

​
Authorization
string

O token de autorização no formato 'Bearer '.

Importante: Este header é obrigatório se o seu ambiente tiver o Access Manager habilitado. Para mais informações, consulte a documentação do Access Manager.

​
X-Organization-id
string
obrigatório

O identificador único da Organização associada à requisição.

Parâmetros de consulta

​
page
integer

O número da página que você deseja recuperar.

​
limit
integer

Número máximo de itens retornados por página.

​
outputFormat
enum<string>

O formato da saída gerada.

Opções disponíveis:
HTML,
CSV,
PDF,
TXT,
XML
​
description
string

Descreve brevemente para que serve o template ou o que ele contém.

​
createdAt
string

Data em que o template foi criado, no formato yyyy-mm-dd.

​
sort_order
enum<string>

Direção de ordenação aplicada aos resultados, com base na data de criação. Valores permitidos: asc ou desc. O padrão é desc.

Opções disponíveis:
asc,
desc

Resposta

A lista de todos os templates disponíveis no sistema.

​
items
object[]

Lista de templates retornados para a página atual.

​
page
integer

Número da página retornada.

​
limit
integer

Número máximo de registros retornados por página.

​
total
integer

Número total de templates disponíveis no sistema.