> ## Documentation Index > Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt > Use this file to discover all available pages before exploring further. # Listar relatórios > Retorna relatórios usando a semântica existente de filtros e paginação por cursor. ## OpenAPI ````yaml pt/openapi/v3-current/reporter.yaml get /v1/reports openapi: 3.1.0 info: contact: name: Discord community url: https://discord.gg/DnhqKwkGv3 description: >- Esta é a documentação OpenAPI do Reporter. O binário unificado do Reporter serve a API REST (RUN_MODE=api) e/ou o worker de geração de relatórios do RabbitMQ (RUN_MODE=worker); RUN_MODE=all executa ambos em um único processo para desenvolvimento local. Todos os endpoints REST documentados aqui são servidos somente quando RUN_MODE=api ou all (porta :4005); o worker (porta :4006) expõe apenas health/readyz. license: name: Lerian Studio General License title: API do Midaz Reporter version: 4.0.0 servers: - url: http://localhost:4005 - url: https://localhost:4005 security: - BearerAuth: [] tags: - description: Instâncias de relatórios gerados e seu ciclo de vida. name: Reports - description: Definições reutilizáveis de relatórios. name: Templates - description: Construção interativa de templates de relatório. name: Template Builder - description: Acompanhamento de datas de vencimento de relatórios agendados. name: Deadlines - description: Entradas configuradas que fornecem dados para relatórios. name: Data Sources - description: Métricas agregadas de relatórios. name: Metrics - description: Catálogo de eventos de negócio publicados e políticas de entrega. name: Streaming paths: /v1/reports: get: tags: - Reports summary: Listar relatórios description: >- Retorna relatórios usando a semântica existente de filtros e paginação por cursor. operationId: listReports parameters: - description: Status do relatório example: Finished in: query name: status schema: type: string - description: UUID do template; templateId também é aceito example: 00000000-0000-0000-0000-000000000000 in: query name: template_id schema: format: uuid type: string - description: Data de criação no formato YYYY-MM-DD; createdAt também é aceito example: '2026-01-31' in: query name: created_at schema: format: date type: string - description: Início da janela do filtro no formato YYYY-MM-DD example: '2026-01-01' in: query name: start_date schema: format: date type: string - description: Fim da janela do filtro no formato YYYY-MM-DD example: '2026-01-31' in: query name: end_date schema: format: date type: string - description: Filtro da descrição do relatório example: Monthly report in: query name: description schema: type: string - description: Formato de saída do relatório example: PDF in: query name: output_format schema: enum: - PDF - HTML - XML - TXT - CSV type: string - description: Filtro de flag ativa example: true in: query name: active schema: type: boolean - description: Filtro do tipo de relatório example: regulatory in: query name: type schema: type: string - description: Cursor opaco para paginação baseada em cursor example: eyJpZCI6IjEyMyJ9 in: query name: cursor schema: type: string - description: Ordem de classificação example: desc in: query name: sort_order schema: default: desc enum: - asc - desc type: string - description: Tamanho da página example: 10 in: query name: limit schema: default: 10 type: integer - description: Número da página example: 1 in: query name: page schema: default: 1 type: integer responses: '200': content: application/json: schema: $ref: '#/components/schemas/ListReportsHumaOutputBody' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Requisição inválida '401': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Não autorizado '403': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Proibido '500': content: application/problem+json: schema: $ref: '#/components/schemas/Detail' description: Erro interno do servidor components: schemas: ListReportsHumaOutputBody: properties: items: description: Relatórios na página atual examples: - - completedAt: '2026-01-31T15:04:05Z' createdAt: '2026-01-31T15:00:00Z' deletedAt: '2026-02-01T09:00:00Z' filters: {} id: 00000000-0000-0000-0000-000000000001 metadata: {} status: Finished templateId: 00000000-0000-0000-0000-000000000002 templateOutputFormat: PDF updatedAt: '2026-01-31T15:04:05Z' items: $ref: '#/components/schemas/Report' type: - array - 'null' limit: description: Número máximo de relatórios na página examples: - 10 format: int64 type: integer page: description: Número da página atual examples: - 1 format: int64 type: integer total: description: Número de relatórios retornados examples: - 10 format: int64 type: integer type: object Detail: properties: code: description: >- Código de erro de domínio estável e legível por máquina, no escopo do serviço emissor (formato: -NNNN). examples: - ERR-0001 type: string detail: description: Explicação legível específica para esta ocorrência do problema. examples: - Property foo is required but is missing. type: string errors: description: Lista opcional de detalhes individuais do erro examples: - - location: body.templateId message: expected string to match 'uuid' format value: not-a-uuid items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: Referência URI que identifica a ocorrência específica do problema. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: Código de status HTTP examples: - 400 format: int64 type: integer title: description: >- Resumo curto e legível do tipo de problema. Esse valor não deve mudar entre ocorrências do erro. examples: - Bad Request type: string type: default: about:blank description: Referência URI para a documentação legível do erro. examples: - https://example.com/errors/example format: uri type: string type: object Report: properties: completedAt: description: Hora em que a geração do relatório foi concluída, quando disponível. examples: - '2026-01-31T15:04:05Z' format: date-time type: - string - 'null' createdAt: description: Hora em que o relatório foi criado. examples: - '2026-01-31T15:00:00Z' format: date-time type: string deletedAt: description: >- Hora em que o relatório foi excluído de forma lógica, quando aplicável. examples: - '2026-02-01T09:00:00Z' format: date-time type: - string - 'null' filters: additionalProperties: additionalProperties: additionalProperties: $ref: '#/components/schemas/FilterCondition' type: object type: object description: Condições de filtro agrupadas por fonte de dados, tabela e campo. examples: - accounts: account: status: eq: - ACTIVE type: object id: description: Identificador estável do relatório. examples: - 00000000-0000-0000-0000-000000000001 type: string metadata: additionalProperties: {} description: Metadados adicionais do relatório, indexados pelo nome do atributo. examples: - source: ledger tenant: sandbox type: object status: description: Status atual da geração do relatório. examples: - Processing type: string templateDescription: description: Descrição copiada do template quando o relatório foi criado. examples: - Monthly accounting report type: string templateId: description: Identificador de origem do snapshot do template. examples: - 00000000-0000-0000-0000-000000000002 type: string templateOutputFormat: description: Formato de saída selecionado para o relatório gerado. examples: - pdf type: string updatedAt: description: Hora da última atualização do relatório. examples: - '2026-01-31T15:04:05Z' format: date-time type: string type: object ErrorDetail: properties: location: description: >- Local em que o erro ocorreu, por exemplo, 'body.items[3].tags' ou 'path.thing-id' examples: - body.templateId type: string message: description: Texto da mensagem de erro examples: - expected string to match 'uuid' format type: string value: description: O valor no local informado examples: - not-a-uuid type: object FilterCondition: properties: between: description: >- Limites inferior e superior inclusivos para uma correspondência por intervalo. examples: - - 100 - 1000 items: {} type: - array - 'null' eq: description: >- Valores comparados por igualdade; vários valores são combinados com OR. examples: - - active - pending items: {} type: - array - 'null' gt: description: Valor único de limite inferior que o campo deve exceder. examples: - - 100 items: {} type: - array - 'null' gte: description: Valor único e inclusivo de limite inferior para o campo. examples: - - '2025-06-01' items: {} type: - array - 'null' in: description: >- Valores para os quais o campo pode corresponder a qualquer item da lista. examples: - - active - pending - suspended items: {} type: - array - 'null' lt: description: >- Valor único de limite superior abaixo do qual o campo deve permanecer. examples: - - 1000 items: {} type: - array - 'null' lte: description: Valor único e inclusivo de limite superior para o campo. examples: - - '2025-06-30' items: {} type: - array - 'null' nin: description: Valores excluídos dos registros correspondentes. examples: - - deleted - archived items: {} type: - array - 'null' type: object securitySchemes: BearerAuth: bearerFormat: JWT description: Token bearer JWT emitido pelo provedor de identidade. scheme: bearer type: http ````