Pular para o conteúdo principal
GET
Listar relatórios

Autorizações

Authorization
string
header
obrigatório

Token bearer JWT emitido pelo provedor de identidade.

Parâmetros de consulta

status
string

Status do relatório

template_id
string<uuid>

UUID do template; templateId também é aceito

created_at
string<date>

Data de criação no formato YYYY-MM-DD; createdAt também é aceito

start_date
string<date>

Início da janela do filtro no formato YYYY-MM-DD

end_date
string<date>

Fim da janela do filtro no formato YYYY-MM-DD

description
string

Filtro da descrição do relatório

output_format
enum<string>

Formato de saída do relatório

Opções disponíveis:
PDF,
HTML,
XML,
TXT,
CSV
active
boolean

Filtro de flag ativa

type
string

Filtro do tipo de relatório

cursor
string

Cursor opaco para paginação baseada em cursor

sort_order
enum<string>
padrão:desc

Ordem de classificação

Opções disponíveis:
asc,
desc
limit
integer
padrão:10

Tamanho da página

page
integer
padrão:1

Número da página

Resposta

OK

items
object[] | null

Relatórios na página atual

Exemplo:
limit
integer<int64>

Número máximo de relatórios na página

Exemplo:

10

page
integer<int64>

Número da página atual

Exemplo:

1

total
integer<int64>

Número de relatórios retornados

Exemplo:

10