Saltar al contenido principal
GET
Obtener informes

Autorizaciones

Authorization
string
header
requerido

Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'. Solo es obligatoria cuando el plugin de autenticación está habilitado.

Parámetros de consulta

status
string

Estado del informe.

template_id
string<uuid>

UUID de la plantilla; también se acepta templateId.

created_at
string<date>

Fecha de creación en formato YYYY-MM-DD; también se acepta createdAt.

start_date
string<date>

Inicio del intervalo de filtrado en formato YYYY-MM-DD.

end_date
string<date>

Fin del intervalo de filtrado en formato YYYY-MM-DD.

description
string

Filtro por descripción del informe.

output_format
enum<string>

Formato de salida del informe.

Opciones disponibles:
PDF,
HTML,
XML,
TXT,
CSV
active
boolean

Filtro por estado activo.

type
string

Filtro por tipo de informe.

cursor
string

Cursor opaco para la paginación basada en cursor.

sort_order
enum<string>
predeterminado:desc

Orden de clasificación.

Opciones disponibles:
asc,
desc
limit
integer
predeterminado:10

Tamaño de la página.

page
integer
predeterminado:1

Número de página.

Respuesta

Correcto

items
object[] | null

Informes de la página actual

Ejemplo:
limit
integer<int64>

Número máximo de informes en la página

Ejemplo:

10

page
integer<int64>

Número de página actual

Ejemplo:

1

total
integer<int64>

Número de informes devueltos

Ejemplo:

10