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

> Use este endpoint para recuperar todas as regras de conciliação de um contexto específico. É possível filtrar os resultados por tipo de regra. A resposta utiliza paginação por cursor.



## OpenAPI

````yaml pt/openapi/v3-current/matcher.yaml get /v1/contexts/{contextId}/rules
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/{contextId}/rules:
    get:
      tags:
        - Configuration Match Rules
      summary: Listar regras de conciliação
      description: >-
        Use este endpoint para recuperar todas as regras de conciliação de um
        contexto específico. É possível filtrar os resultados por tipo de regra.
        A resposta utiliza paginação por cursor.
      operationId: listMatchRules
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: The unique identifier of the reconciliation context.
          in: path
          name: contextId
          required: true
          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 rule type
          in: query
          name: type
          schema:
            type: string
            enum:
              - EXACT
              - TOLERANCE
              - DATE_LAG
      responses:
        '200':
          description: Lista de regras de conciliação com paginação por cursor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMatchRulesResponse'
        '400':
          description: Parâmetros de consulta inválidos
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: A requisição não contém credenciais de autenticação válidas.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Você não tem permissão para acessar este recurso.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Contexto não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '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:
    ListMatchRulesResponse:
      description: Lista paginada por cursor de regras de conciliação
      properties:
        hasMore:
          example: true
          type: boolean
        items:
          description: Lista de regras de conciliação
          items:
            $ref: '#/components/schemas/MatchRuleResponse'
          type: array
        limit:
          example: 20
          maximum: 200
          minimum: 1
          type: integer
        nextCursor:
          example: eyJpZCI6IjEyMyJ9
          type: string
        prevCursor:
          example: eyJpZCI6IjEyMiJ9
          type: string
      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
    MatchRuleResponse:
      description: Regra de conciliação dentro de um contexto de conciliação
      properties:
        config:
          additionalProperties: {}
          description: Configuração da regra
          type: object
        contextId:
          description: ID do contexto ao qual esta regra pertence
          example: 019c96a0-10a0-72d2-9fb0-2b7de8093182
          type: string
        createdAt:
          description: Timestamp de criação no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
        id:
          description: Identificador único da regra
          example: 019c96a0-1071-7a0d-9916-a831221de252
          type: string
        priority:
          description: Prioridade de execução (menor = maior prioridade)
          example: 1
          maximum: 1000
          minimum: 1
          type: integer
        type:
          description: Tipo de regra de conciliação
          enum:
            - EXACT
            - TOLERANCE
            - DATE_LAG
          example: EXACT
          type: string
        updatedAt:
          description: Timestamp da última atualização no formato RFC3339
          example: '2025-01-15T10:30:00.000Z'
          type: string
      type: object
  examples:
    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}")'

````