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

> Retorna templates usando a semântica existente de filtros e paginação.



## OpenAPI

````yaml pt/openapi/v3-current/reporter.yaml get /v1/templates
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/templates:
    get:
      tags:
        - Templates
      summary: Listar templates
      description: Retorna templates usando a semântica existente de filtros e paginação.
      operationId: listTemplates
      parameters:
        - description: Formato de saída do template
          example: HTML
          in: query
          name: outputFormat
          schema:
            type: string
        - description: Tamanho da página; analisado pelo validador de consultas do domínio
          example: 10
          in: query
          name: limit
          schema:
            default: 10
            type: integer
        - description: Número da página; analisado pelo validador de consultas do domínio
          example: 1
          in: query
          name: page
          schema:
            default: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListTemplatesHumaOutputBody'
          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:
    ListTemplatesHumaOutputBody:
      properties:
        items:
          description: Templates na página atual
          examples:
            - - createdAt: '2026-01-01T00:00:00Z'
                description: Monthly financial report
                fileName: monthly-report.tpl
                id: 00000000-0000-0000-0000-000000000000
                outputFormat: HTML
                updatedAt: '2026-01-01T00:00:00Z'
          items:
            $ref: '#/components/schemas/Template'
          type:
            - array
            - 'null'
        limit:
          description: Número máximo de templates 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 total de templates correspondentes
          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: <SERVICE>-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
    Template:
      properties:
        createdAt:
          description: Timestamp de criação do template em UTC
          examples:
            - '2021-01-01T00:00:00Z'
          format: date-time
          type: string
        description:
          description: Descrição legível do template
          examples:
            - Monthly financial report
          type: string
        fileName:
          description: Nome do arquivo de template armazenado
          examples:
            - 0196159b-4f26-7300-b3d9-f4f68a7c85f3_1744119295.tpl
          type: string
        id:
          description: Identificador único do template
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        outputFormat:
          description: Formato gerado a partir deste template
          examples:
            - HTML
          type: string
        updatedAt:
          description: Timestamp da atualização mais recente do template em UTC
          examples:
            - '2021-01-01T00:00:00Z'
          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
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      description: Token bearer JWT emitido pelo provedor de identidade.
      scheme: bearer
      type: http

````