> ## 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.

# Obtener informes

> Usa este endpoint para recuperar informes creados anteriormente.



## OpenAPI

````yaml es/openapi/v3-current/reporter.yaml get /v1/reports
openapi: 3.1.0
info:
  contact:
    name: Discord community
    url: https://discord.gg/DnhqKwkGv3
  description: >-
    Esta es la documentación OpenAPI de Reporter. El binario unificado de
    Reporter ejecuta la API REST (RUN_MODE=api), el worker de generación de
    informes de RabbitMQ (RUN_MODE=worker) o ambos; RUN_MODE=all ejecuta los dos
    en un único proceso para el desarrollo local. Todos los endpoints REST
    documentados aquí solo están disponibles cuando RUN_MODE=api o RUN_MODE=all
    (puerto :4005); el worker (puerto :4006) expone únicamente los endpoints de
    health y readyz.
  license:
    name: Lerian Studio General License
  title: Midaz Reporter API
  version: 4.0.0
servers:
  - url: http://localhost:4005
  - url: https://localhost:4005
security:
  - BearerAuth: []
tags:
  - description: Instancias de informes generados y su ciclo de vida.
    name: Informes
  - description: Definiciones de informes reutilizables.
    name: Plantillas
  - description: Creación interactiva de plantillas de informes.
    name: Constructor de plantillas
  - description: Seguimiento de las fechas de vencimiento de informes programados.
    name: Plazos
  - description: Entradas configuradas que proporcionan datos a los informes.
    name: Fuentes de datos
  - description: Métricas agregadas de informes.
    name: Métricas
  - description: Catálogo publicado de eventos de negocio y políticas de entrega.
    name: Streaming
paths:
  /v1/reports:
    get:
      tags:
        - Informes
      summary: Obtener informes
      description: Usa este endpoint para recuperar informes creados anteriormente.
      operationId: listReports
      parameters:
        - description: Estado del informe.
          example: Finished
          in: query
          name: status
          schema:
            type: string
        - description: UUID de la plantilla; también se acepta `templateId`.
          example: 00000000-0000-0000-0000-000000000000
          in: query
          name: template_id
          schema:
            format: uuid
            type: string
        - description: >-
            Fecha de creación en formato `YYYY-MM-DD`; también se acepta
            `createdAt`.
          example: '2026-01-31'
          in: query
          name: created_at
          schema:
            format: date
            type: string
        - description: Inicio del intervalo de filtrado en formato `YYYY-MM-DD`.
          example: '2026-01-01'
          in: query
          name: start_date
          schema:
            format: date
            type: string
        - description: Fin del intervalo de filtrado en formato `YYYY-MM-DD`.
          example: '2026-01-31'
          in: query
          name: end_date
          schema:
            format: date
            type: string
        - description: Filtro por descripción del informe.
          example: Monthly report
          in: query
          name: description
          schema:
            type: string
        - description: Formato de salida del informe.
          example: PDF
          in: query
          name: output_format
          schema:
            enum:
              - PDF
              - HTML
              - XML
              - TXT
              - CSV
            type: string
        - description: Filtro por estado activo.
          example: true
          in: query
          name: active
          schema:
            type: boolean
        - description: Filtro por tipo de informe.
          example: regulatory
          in: query
          name: type
          schema:
            type: string
        - description: Cursor opaco para la paginación basada en cursor.
          example: eyJpZCI6IjEyMyJ9
          in: query
          name: cursor
          schema:
            type: string
        - description: Orden de clasificación.
          example: desc
          in: query
          name: sort_order
          schema:
            default: desc
            enum:
              - asc
              - desc
            type: string
        - description: Tamaño de la página.
          example: 10
          in: query
          name: limit
          schema:
            default: 10
            type: integer
        - description: Número de página.
          example: 1
          in: query
          name: page
          schema:
            default: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReportsHumaOutputBody'
          description: Correcto
        '400':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Solicitud incorrecta
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: No autorizado
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Prohibido
        '500':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error interno del servidor
components:
  schemas:
    ListReportsHumaOutputBody:
      properties:
        items:
          description: Informes de la página actual
          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 informes en la página
          examples:
            - 10
          format: int64
          type: integer
        page:
          description: Número de página actual
          examples:
            - 1
          format: int64
          type: integer
        total:
          description: Número de informes devueltos
          examples:
            - 10
          format: int64
          type: integer
      type: object
    Detail:
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, limitado
            al servicio emisor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: Explicación legible específica de esta instancia del problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalles individuales del error
          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: Referencia URI que identifica la instancia específica del problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Resumen breve y legible del tipo de problema. Este valor no debe
            cambiar entre instancias del error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: Referencia URI a la documentación legible del error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    Report:
      properties:
        completedAt:
          description: >-
            Fecha y hora en que finalizó la generación del informe, cuando está
            disponible.
          examples:
            - '2026-01-31T15:04:05Z'
          format: date-time
          type:
            - string
            - 'null'
        createdAt:
          description: Fecha y hora en que se creó el informe.
          examples:
            - '2026-01-31T15:00:00Z'
          format: date-time
          type: string
        deletedAt:
          description: >-
            Fecha y hora en que se eliminó lógicamente el informe, cuando
            aplica.
          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: Condiciones de filtro agrupadas por fuente de datos, tabla y campo.
          examples:
            - accounts:
                account:
                  status:
                    eq:
                      - ACTIVE
          type: object
        id:
          description: Identificador estable del informe.
          examples:
            - 00000000-0000-0000-0000-000000000001
          type: string
        metadata:
          additionalProperties: {}
          description: Metadatos adicionales del informe indexados por nombre de atributo.
          examples:
            - source: ledger
              tenant: sandbox
          type: object
        status:
          description: Estado actual de generación del informe.
          examples:
            - Processing
          type: string
        templateDescription:
          description: Descripción copiada de la plantilla cuando se creó el informe.
          examples:
            - Monthly accounting report
          type: string
        templateId:
          description: Identificador de origen de la instantánea de la plantilla.
          examples:
            - 00000000-0000-0000-0000-000000000002
          type: string
        templateOutputFormat:
          description: Formato de salida seleccionado para el informe generado.
          examples:
            - pdf
          type: string
        updatedAt:
          description: Fecha y hora de la última actualización del informe.
          examples:
            - '2026-01-31T15:04:05Z'
          format: date-time
          type: string
      type: object
    ErrorDetail:
      properties:
        location:
          description: >-
            Lugar donde ocurrió el error, por ejemplo, 'body.items[3].tags' o
            'path.thing-id'
          examples:
            - body.templateId
          type: string
        message:
          description: Texto del mensaje de error
          examples:
            - expected string to match 'uuid' format
          type: string
        value:
          description: Valor en la ubicación indicada
          examples:
            - not-a-uuid
      type: object
    FilterCondition:
      properties:
        between:
          description: >-
            Límites inferior y superior inclusivos para una coincidencia de
            rango.
          examples:
            - - 100
              - 1000
          items: {}
          type:
            - array
            - 'null'
        eq:
          description: >-
            Valores que se comparan por igualdad; los valores múltiples se
            combinan con OR.
          examples:
            - - active
              - pending
          items: {}
          type:
            - array
            - 'null'
        gt:
          description: Valor único de límite inferior que el campo debe superar.
          examples:
            - - 100
          items: {}
          type:
            - array
            - 'null'
        gte:
          description: Valor único de límite inferior inclusivo para el campo.
          examples:
            - - '2025-06-01'
          items: {}
          type:
            - array
            - 'null'
        in:
          description: >-
            Valores para los que el campo puede coincidir con cualquier elemento
            de la lista.
          examples:
            - - active
              - pending
              - suspended
          items: {}
          type:
            - array
            - 'null'
        lt:
          description: >-
            Valor único de límite superior por debajo del cual debe permanecer
            el campo.
          examples:
            - - 1000
          items: {}
          type:
            - array
            - 'null'
        lte:
          description: Valor único de límite superior inclusivo para el campo.
          examples:
            - - '2025-06-30'
          items: {}
          type:
            - array
            - 'null'
        nin:
          description: Valores excluidos de los registros coincidentes.
          examples:
            - - deleted
              - archived
          items: {}
          type:
            - array
            - 'null'
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: >-
        Autenticación mediante token Bearer. Formato: 'Bearer {access_token}'.
        Solo es obligatoria cuando el plugin de autenticación está habilitado.
      scheme: bearer
      type: http

````