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

# List reconciliation contexts

> Use this endpoint to retrieve all reconciliation contexts.  

Supports filtering by type and status and uses cursor-based pagination.




## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml get /v1/contexts
openapi: 3.1.0
info:
  title: Matcher APIs
  description: >-
    Complete API reference for the Matcher reconciliation engine, providing
    automated transaction matching between Midaz Ledger and external systems.
  version: v2.1.1
  license:
    name: Elastic License 2.0
    url: https://www.elastic.co/licensing/elastic-license
servers:
  - url: https://matcher.sandbox.lerian.net
security: []
paths:
  /v1/contexts:
    get:
      tags:
        - Configuration Contexts
      summary: List reconciliation contexts
      description: |
        Use this endpoint to retrieve all reconciliation contexts.  

        Supports filtering by type and status and uses cursor-based pagination.
      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: List of contexts with cursor pagination
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListContextsResponse'
        '400':
          description: Invalid query parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0001:
                  $ref: '#/components/examples/ErrorM0001'
        '401':
          description: The request lacks valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0101:
                  $ref: '#/components/examples/ErrorM0101'
                ErrorM0102:
                  $ref: '#/components/examples/ErrorM0102'
        '403':
          description: You do not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ErrorM0103:
                  $ref: '#/components/examples/ErrorM0103'
      security:
        - BearerAuth: []
components:
  schemas:
    ListContextsResponse:
      description: Cursor-paginated list of reconciliation contexts
      properties:
        items:
          description: List of reconciliation contexts
          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: Standard error response returned by all API endpoints
      type: object
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: HTTP status code as a string.
          example: '404'
        title:
          type: string
          description: Error type identifier.
          example: not_found
        message:
          type: string
          description: Human-readable error message with details.
          example: context not found
        error:
          type: string
          description: Deprecated. Error message for backward compatibility.
          deprecated: true
        details:
          description: Additional error context as key-value pairs
          additionalProperties: {}
          type: object
    ReconciliationContextResponse:
      description: Configuration context for matching rules
      properties:
        id:
          description: Unique identifier for the context
          example: 019c96a0-10a0-72d2-9fb0-2b7de8093182
          type: string
        tenantId:
          description: Tenant ID this context belongs to
          example: 019c96a0-0a98-7287-9a31-786e0809c769
          type: string
        name:
          description: Name of the reconciliation context
          example: Bank Reconciliation Q1
          type: string
        type:
          description: Reconciliation topology type
          enum:
            - '1:1'
            - 1:N
            - N:M
          example: '1:1'
          type: string
        interval:
          description: Execution interval
          example: daily
          type: string
        status:
          description: Current status of the context
          enum:
            - DRAFT
            - ACTIVE
            - PAUSED
            - ARCHIVED
          example: ACTIVE
          type: string
        feeToleranceAbs:
          description: Absolute fee tolerance amount
          example: '0.50'
          type: string
        feeTolerancePct:
          description: Percentage fee tolerance
          example: '0.01'
          type: string
        feeNormalization:
          description: Fee normalization mode
          enum:
            - NET
            - GROSS
          example: NET
          type: string
        autoMatchOnUpload:
          description: Whether matching triggers automatically after file upload
          example: false
          type: boolean
        createdAt:
          description: Creation timestamp in RFC3339 format
          example: '2025-01-15T10:30:00.000Z'
          type: string
        updatedAt:
          description: Last update timestamp in RFC3339 format
          example: '2025-01-15T10:30:00.000Z'
          type: string
      type: object
  examples:
    ErrorM0001:
      summary: Bad Request
      value:
        code: '400'
        title: invalid_request
        message: >-
          The request contains invalid parameters or malformed syntax. Please
          check your request and try again.
    ErrorM0101:
      summary: Token Missing
      value:
        code: '401'
        title: unauthorized
        message: >-
          No authentication token was provided. Please include a valid Bearer
          token in the Authorization header.
    ErrorM0102:
      summary: Invalid Token
      value:
        code: '401'
        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: '403'
        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.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer token authentication (format: "Bearer {token}")'

````