> ## 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 match runs > Use this endpoint to retrieve all match runs for a specific reconciliation context. The results are sorted by creation time descending. ## OpenAPI ````yaml /pt/openapi/v3-current/matcher.yaml get /v1/matching/contexts/{contextId}/runs 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: 6.1.0 license: name: Lerian Studio General License servers: - url: https://matcher.sandbox.lerian.net security: [] paths: /v1/matching/contexts/{contextId}/runs: get: tags: - Matching summary: List match runs description: >- Use this endpoint to retrieve all match runs for a specific reconciliation context. The results are sorted by creation time descending. operationId: listMatchRuns 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: description: Context ID format: uuid type: string - description: The maximum number of items to include in the response. explode: false in: query name: limit schema: default: 20 description: Maximum number of records to return format: int64 maximum: 200 minimum: 1 type: integer - description: The cursor value for retrieving the next page of results. explode: false in: query name: cursor schema: description: Opaque pagination cursor type: string - description: The order used to sort the results. explode: false in: query name: sort_order schema: description: Sort order enum: - asc - desc 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/ListMatchRunsResponse' '400': description: The request contains invalid parameters or payload. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: 400-invalid-pagination-parameters: $ref: >- #/components/examples/400-invalid-pagination-parameters--get-v1-matching-contexts-contextid-runs '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': description: The requested resource was not found. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: mtch-0005-context-not-found: $ref: '#/components/examples/mtch-0005-context-not-found' '422': $ref: '#/components/responses/ValidationFailed' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalServerError' security: - BearerAuth: [] components: schemas: ListMatchRunsResponse: additionalProperties: false properties: hasMore: examples: - true type: boolean items: description: Page of match runs items: $ref: '#/components/schemas/MatchRunResponse' maxItems: 200 type: - array - 'null' limit: examples: - 20 format: int64 maximum: 200 minimum: 1 type: integer nextCursor: examples: - eyJpZCI6IjEyMyJ9 type: string prevCursor: examples: - eyJpZCI6IjEyMiJ9 type: string required: - items - limit - hasMore type: object Detail: additionalProperties: false properties: code: description: >- Stable, machine-readable domain error code scoped to the emitting service (format: -NNNN). examples: - ERR-0001 type: string detail: description: >- A human-readable explanation specific to this occurrence of the problem. examples: - Property foo is required but is missing. type: string errors: description: Optional list of individual error details items: $ref: '#/components/schemas/ErrorDetail' type: - array - 'null' instance: description: >- A URI reference that identifies the specific occurrence of the problem. examples: - https://example.com/error-log/abc123 format: uri type: string status: description: HTTP status code examples: - 400 format: int64 type: integer title: description: >- A short, human-readable summary of the problem type. This value should not change between occurrences of the error. examples: - Bad Request type: string type: default: about:blank description: A URI reference to human-readable documentation for the error. examples: - https://example.com/errors/example format: uri type: string upstream: $ref: '#/components/schemas/Upstream' description: >- RFC 9457 extension member: the error a proxied third-party provider reported. Absent unless the emitting service explicitly surfaced one. type: object MatchRunResponse: additionalProperties: false properties: completedAt: description: >- When the run completed (RFC 3339 timestamp); absent until the run finishes examples: - '2025-01-15T10:35:00Z' type: string contextId: description: Reconciliation context ID this run belongs to examples: - 550e8400-e29b-41d4-a716-446655440000 type: string createdAt: description: Creation timestamp (RFC 3339) examples: - '2025-01-15T10:30:00Z' type: string failureReason: description: Failure reason; present only when the run status is FAILED examples: - no matching rules found type: string id: description: Unique identifier for the run examples: - 550e8400-e29b-41d4-a716-446655440000 type: string mode: description: >- Execution mode: DRY_RUN evaluates rules without committing matches; COMMIT persists matches enum: - DRY_RUN - COMMIT examples: - DRY_RUN type: string ruleStats: description: >- Structured per-rule matched group counts frozen at run completion. Every rule configured at run time appears, including zero-match rules, and the matched counts sum to the run's matches stat. Absent on runs completed before the keys were introduced items: $ref: '#/components/schemas/MatchRunRuleStatResponse' type: - array - 'null' startedAt: description: When the run started (RFC 3339 timestamp) examples: - '2025-01-15T10:30:00Z' type: string stats: additionalProperties: format: int64 type: integer description: >- Aggregate run statistics as an open key-value map; consumers must tolerate unknown keys and treat a missing key as unknown rather than zero. Known keys include matches, candidates_left, candidates_right, unmatched_left, unmatched_right, unmatched_external, auto_matched_left, auto_matched_right, pending_review_left, pending_review_right, proposed_left, proposed_right, exceptions_raised (newly created), exceptions_updated (re-touched), plus per-rule families rule_matched: and rule_meta::. A run recovered after an interruption reports the exception rows its earlier attempt created under exceptions_updated, not exceptions_raised type: object status: description: >- Current status of the run: QUEUED (async submit, awaiting worker pickup), PROCESSING (in flight), FINALIZING (a transient finishing-up state — a poll MAY briefly observe it between PROCESSING and COMPLETED, and it is also observable while a run is recovered after a crash; treat it as in-flight, not terminal), COMPLETED (finished), or FAILED (errored). An async run in flight when its pod stops goes back from PROCESSING to QUEUED and is picked up again with a new startedAt enum: - QUEUED - PROCESSING - FINALIZING - COMPLETED - FAILED examples: - COMPLETED type: string updatedAt: description: Last update timestamp (RFC 3339) examples: - '2025-01-15T10:30:00Z' type: string required: - id - contextId - mode - status - startedAt - createdAt - updatedAt type: object ErrorDetail: additionalProperties: false properties: location: description: >- Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' type: string message: description: Error message text type: string value: description: The value at the given location type: object Upstream: additionalProperties: false properties: code: description: The upstream provider's own error code, verbatim. examples: - E4001 type: string message: description: >- The upstream provider's own error message, verbatim (bounded, never its raw response body). examples: - account not found at provider type: string type: object RateLimitErrorResponse: description: >- Flat body that the rate limiter returns. `code` is the HTTP status as a number. type: object required: - code - title - message properties: code: type: integer description: HTTP status code. example: 429 title: type: string description: Error type. example: rate_limit_exceeded message: type: string description: Human-readable error message. example: rate limit exceeded MatchRunRuleStatResponse: additionalProperties: false properties: matched: description: >- Match groups this rule produced in this run; zero means the rule matched nothing, and counts across all rules sum to the run's matches stat examples: - 42 format: int64 type: integer priority: description: Rule priority at run time (lower runs first) examples: - 1 format: int64 type: integer ruleId: description: Identifier of the match rule, frozen at run completion examples: - 550e8400-e29b-41d4-a716-446655440000 type: string type: description: >- Rule type at run time: EXACT (strict equality), TOLERANCE (within an amount band), DATE_LAG (allowing a settlement-date offset), or FUZZY (normalized/similarity-scored references, always proposes). Absent when the run recorded a match count for the rule without its metadata sibling enum: - EXACT - TOLERANCE - DATE_LAG - FUZZY examples: - EXACT type: string required: - ruleId - priority - matched type: object examples: 400-invalid-pagination-parameters--get-v1-matching-contexts-contextid-runs: summary: Invalid pagination parameters value: title: Bad Request status: 400 detail: >- The pagination cursor could not be decoded; omit it to start from the first page, or use the exact cursor value returned by a previous response mtch-0005-context-not-found: summary: Context not found value: type: https://errors.lerian.studio/v1/MTCH-0005 title: Not Found status: 404 detail: >- No reconciliation context matches this id; check the context id and try again. code: MTCH-0005 responses: Unauthorized: description: The request lacks valid authentication credentials. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: MissingToken: summary: Missing token value: type: https://errors.lerian.studio/v1/AUT-0006 title: Token Missing status: 401 detail: >- A valid token must be provided in the request header. Please include a token and try again. code: AUT-0006 InvalidToken: summary: Invalid token value: type: https://errors.lerian.studio/v1/AUT-0007 title: Invalid Token status: 401 detail: >- The provided token is expired, invalid or malformed. Please provide a valid token and try again. code: AUT-0007 Forbidden: description: You do not have permission to access this resource. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' examples: TenantClaimRequired: summary: Tenant claim missing value: type: https://errors.lerian.studio/v1/MTCH-0004 title: Forbidden status: 403 detail: tenant claim required code: MTCH-0004 PermissionDenied: summary: Permission denied value: type: https://errors.lerian.studio/v1/AUT-1020 title: Permission Denied status: 403 detail: >- the credential is not allowed to perform contexts:read on this request code: AUT-1020 ValidationFailed: description: >- The request failed validation. The `errors` list names each value that failed. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' example: title: Unprocessable Entity status: 422 detail: validation failed errors: - message: expected required property name to be present location: body TooManyRequests: description: >- The request exceeded the rate limit. Wait the number of seconds in `Retry-After`, then retry. headers: Retry-After: $ref: '#/components/headers/RetryAfter' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/RateLimitErrorResponse' example: code: 429 title: rate_limit_exceeded message: rate limit exceeded InternalServerError: description: An unexpected error occurred on the server. content: application/problem+json: schema: $ref: '#/components/schemas/Detail' example: type: https://errors.lerian.studio/v1/MTCH-0002 title: Internal Server Error status: 500 detail: internal error code: MTCH-0002 text/plain: schema: type: string example: Internal Server Error headers: RetryAfter: description: Seconds to wait before you retry. schema: type: integer example: 30 XRateLimitLimit: description: Requests allowed in the current window. schema: type: integer example: 100 XRateLimitRemaining: description: Requests left in the current window. Always `0` on a `429`. schema: type: integer example: 0 XRateLimitReset: description: Unix time, in seconds, when the current window resets. schema: type: integer example: 1767225600 securitySchemes: BearerAuth: bearerFormat: JWT description: 'Bearer token authentication (format: "Bearer {token}")' scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.