> ## 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 contextos de conciliação

> Use este endpoint para recuperar todos os contextos de conciliação.  

Oferece suporte a filtragem por tipo e status e utiliza paginação por cursor.




## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/contexts
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Referência completa de API para o motor de conciliação Matcher, que fornece
    conciliação automática de transações entre o Midaz Ledger e sistemas
    externos.
  version: 4.1.0
  license:
    name: Lerian Studio General License
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/contexts:
    get:
      tags:
        - Configuration Contexts
      summary: Listar contextos de conciliação
      description: >
        Use este endpoint para recuperar todos os contextos de conciliação.  


        Oferece suporte a filtragem por tipo e status e utiliza paginação por
        cursor.
      operationId: listContexts
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The maximum number of items to include in the response.
          in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 20
        - description: The cursor value for retrieving the next page of results.
          in: query
          name: cursor
          schema:
            type: string
        - description: Filter by context type
          in: query
          name: type
          schema:
            type: string
            enum:
              - '1:1'
              - 1:N
              - N:M
        - description: Filter by context status
          in: query
          name: status
          schema:
            type: string
            enum:
              - DRAFT
              - ACTIVE
              - PAUSED
              - ARCHIVED
      responses:
        '200':
          description: Lista de contextos com paginação por cursor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContextsResponse'
        '400':
          description: Parâmetros de consulta inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0001:
                  $ref: '#/components/examples/ErrorM0001'
        '401':
          description: A requisição não contém credenciais de autenticação válidas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0101:
                  $ref: '#/components/examples/ErrorM0101'
                ErrorM0102:
                  $ref: '#/components/examples/ErrorM0102'
        '403':
          description: Você não tem permissão para acessar este recurso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0103:
                  $ref: '#/components/examples/ErrorM0103'
        '500':
          description: Ocorreu um erro inesperado no servidor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0002:
                  $ref: '#/components/examples/ErrorM0002'
      security:
        - BearerAuth: []
components:
  schemas:
    ListContextsResponse:
      description: Lista paginada por cursor de contextos de conciliação
      properties:
        items:
          description: Lista de contextos de conciliação
          items:
            $ref: '#/components/schemas/ReconciliationContextResponse'
          type: array
        nextCursor:
          example: eyJpZCI6IjEyMyJ9
          type: string
        limit:
          example: 20
          maximum: 200
          minimum: 1
          type: integer
        prevCursor:
          example: eyJpZCI6IjEyMiJ9
          type: string
        hasMore:
          example: true
          type: boolean
      type: object
    ErrorResponse:
      description: Resposta de erro padrão retornada por todos os endpoints da API
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: Código de erro de aplicação estável.
          example: MTCH-0001
        title:
          type: string
          description: Título de erro legível por humanos.
          example: Bad Request
        message:
          type: string
          description: Mensagem de erro legível com detalhes.
          example: context not found
        error:
          type: string
          description: Descontinuado. Mensagem de erro para compatibilidade retroativa.
          deprecated: true
        details:
          description: Contexto adicional do erro como pares chave-valor
          additionalProperties: {}
          type: object
    ReconciliationContextResponse:
      description: Contexto de configuração para regras de conciliação
      properties:
        id:
          description: Identificador único do contexto
          example: 019c96a0-10a0-72d2-9fb0-2b7de8093182
          type: string
        tenantId:
          description: ID do tenant ao qual este contexto pertence
          example: 019c96a0-0a98-7287-9a31-786e0809c769
          type: string
        name:
          description: Nome do contexto de conciliação
          example: Bank Reconciliation Q1
          type: string
        type:
          description: Tipo de topologia de conciliação
          enum:
            - '1:1'
            - 1:N
            - N:M
          example: '1:1'
          type: string
        interval:
          description: Intervalo de execução
          example: daily
          type: string
        status:
          description: Status atual do contexto
          enum:
            - DRAFT
            - ACTIVE
            - PAUSED
            - ARCHIVED
          example: ACTIVE
          type: string
        feeToleranceAbs:
          description: Valor absoluto de tolerância de tarifa
          example: '0.50'
          type: string
        feeTolerancePct:
          description: Tolerância de tarifa percentual
          example: '0.01'
          type: string
        feeNormalization:
          description: Modo de normalização de tarifas
          enum:
            - NET
            - GROSS
          example: NET
          type: string
        autoMatchOnUpload:
          description: >-
            Se a conciliação é disparada automaticamente após o upload de
            arquivo
          example: false
          type: boolean
        createdAt:
          description: Timestamp de criação no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
        updatedAt:
          description: Timestamp da última atualização no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
      type: object
  examples:
    ErrorM0001:
      summary: Bad Request
      value:
        code: MTCH-0001
        title: Bad Request
        message: >-
          The request contains invalid parameters or malformed syntax. Please
          check your request and try again.
    ErrorM0101:
      summary: Token Missing
      value:
        code: MTCH-0003
        title: Unauthorized
        message: >-
          No authentication token was provided. Please include a valid Bearer
          token in the Authorization header.
    ErrorM0102:
      summary: Invalid Token
      value:
        code: MTCH-0003
        title: Unauthorized
        message: >-
          The provided token is expired, invalid, or malformed. Please provide a
          valid token and try again.
    ErrorM0103:
      summary: Insufficient Privileges
      value:
        code: MTCH-0004
        title: Forbidden
        message: >-
          You do not have the necessary permissions to perform this action.
          Please contact your administrator if you believe this is an error.
    ErrorM0002:
      summary: Internal Server Error
      value:
        code: MTCH-0002
        title: Internal Server Error
        message: internal server error
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Autenticação por Bearer token (formato: "Bearer {token}")'

````