List match runs

Use this endpoint to retrieve all match runs for a specific reconciliation context. The results are sorted by creation time descending.

GET /v1/matching/contexts/{contextId}/runs

List match runs

cURL

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/matching/contexts/{contextId}/runs \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "items": [
    {
      "completedAt": "<string>",
      "contextId": "<string>",
      "createdAt": "<string>",
      "failureReason": "<string>",
      "id": "<string>",
      "startedAt": "<string>",
      "stats": {},
      "updatedAt": "<string>"
    }
  ],
  "limit": 20,
  "nextCursor": "eyJpZCI6IjEyMyJ9",
  "prevCursor": "eyJpZCI6IjEyMiJ9"
}

Authorizations

Authorization · string · header · required

Bearer token authentication (format: "Bearer {token}")

Headers

X-Request-Id · string

A unique identifier for tracing the request across services.

Path Parameters

contextId · string · required

The unique identifier of the reconciliation context.

Query Parameters

limit · integer · default: 20

The maximum number of items to include in the response.

Required range: 1 <= x <= 200

cursor · string

The cursor value for retrieving the next page of results.

sort_order · enum<string>

The order used to sort the results.

Available options: asc, desc

Response

200

application/json

Indicates that the request was successful and the response contains the expected data.

Cursor-paginated list of match runs

hasMore · boolean

Example:

true

items · object[]

List of match runs

Show child attributes

limit · integer

Required range: 1 <= x <= 200

Example:

20

nextCursor · string

Example:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Example:

"eyJpZCI6IjEyMiJ9"