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

# Get match run results

> Use this endpoint to retrieve all match groups from a specific matching run. Each group contains matched transaction pairs and confidence scores. The response uses cursor-based pagination.



## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml get /v1/matching/runs/{runId}/groups
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/matching/runs/{runId}/groups:
    get:
      tags:
        - Matching
      summary: Get match run results
      description: >-
        Use this endpoint to retrieve all match groups from a specific matching
        run. Each group contains matched transaction pairs and confidence
        scores. The response uses cursor-based pagination.
      operationId: getMatchRunGroups
      parameters:
        - description: A unique identifier for tracing the request across services.
          in: header
          name: X-Request-Id
          schema:
            type: string
        - description: Run ID
          in: path
          name: runId
          required: true
          schema:
            type: string
        - description: Context ID
          in: query
          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: The order used to sort the results.
          in: query
          name: sort_order
          schema:
            type: string
            enum:
              - asc
              - desc
        - description: The field used to sort the results.
          in: query
          name: sort_by
          schema:
            type: string
            enum:
              - id
              - created_at
              - status
      responses:
        '200':
          description: >-
            Indicates that the request was successful and the response contains
            the expected data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListMatchGroupsResponse'
        '400':
          description: The request contains invalid parameters or payload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: The request lacks valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: You do not have permission to access this resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: An unexpected error occurred on the server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    ListMatchGroupsResponse:
      description: Cursor-paginated list of match groups
      properties:
        hasMore:
          example: true
          type: boolean
        items:
          description: List of match groups
          items:
            $ref: '#/components/schemas/MatchGroupResponse'
          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: 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
    MatchGroupResponse:
      properties:
        confidence:
          $ref: '#/components/schemas/ConfidenceScore'
        confirmedAt:
          type: string
        contextId:
          type: string
        createdAt:
          type: string
        id:
          type: string
        items:
          items:
            $ref: '#/components/schemas/MatchItemResponse'
          type: array
        rejectedReason:
          type: string
        ruleId:
          type: string
        runId:
          type: string
        status:
          $ref: '#/components/schemas/MatchGroupStatus'
        updatedAt:
          type: string
      type: object
    ConfidenceScore:
      type: object
    MatchItemResponse:
      properties:
        allocatedAmount:
          type: number
        allocatedCurrency:
          type: string
        allowPartial:
          type: boolean
        createdAt:
          type: string
        expectedAmount:
          type: number
        id:
          type: string
        matchGroupId:
          type: string
        transactionId:
          type: string
        updatedAt:
          type: string
      type: object
    MatchGroupStatus:
      description: Lifecycle status of a match group
      enum:
        - PROPOSED
        - CONFIRMED
        - REJECTED
      type: string
      x-enum-varnames:
        - MatchGroupStatusProposed
        - MatchGroupStatusConfirmed
        - MatchGroupStatusRejected
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer token authentication (format: "Bearer {token}")'

````