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

> Use this endpoint to retrieve the details of a specific match run by its identifier. The response includes status, timing, and aggregate statistics.



## OpenAPI

````yaml /en/openapi/v3-current/matcher.yaml get /v1/matching/runs/{runId}
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}:
    get:
      tags:
        - Matching
      summary: Get match run
      description: >-
        Use this endpoint to retrieve the details of a specific match run by its
        identifier. The response includes status, timing, and aggregate
        statistics.
      operationId: getMatchRun
      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
      responses:
        '200':
          description: >-
            Indicates that the request was successful and the response contains
            the expected data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MatchRunResponse'
        '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:
    MatchRunResponse:
      properties:
        completedAt:
          type: string
        contextId:
          type: string
        createdAt:
          type: string
        failureReason:
          type: string
        id:
          type: string
        mode:
          $ref: '#/components/schemas/MatchRunMode'
        startedAt:
          type: string
        stats:
          additionalProperties:
            type: integer
          type: object
        status:
          $ref: '#/components/schemas/MatchRunStatus'
        updatedAt:
          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
    MatchRunMode:
      description: Execution mode for a matching run
      enum:
        - DRY_RUN
        - COMMIT
      type: string
      x-enum-varnames:
        - MatchRunModeDryRun
        - MatchRunModeCommit
    MatchRunStatus:
      description: Lifecycle status of a matching run
      enum:
        - PROCESSING
        - COMPLETED
        - FAILED
      type: string
      x-enum-varnames:
        - MatchRunStatusProcessing
        - MatchRunStatusCompleted
        - MatchRunStatusFailed
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Bearer token authentication (format: "Bearer {token}")'

````