List match rules

Use this endpoint to retrieve all match rules under a specific context. You can filter the results by rule type. The response uses cursor-based pagination.

GET /v1/contexts/{contextId}/rules

List match rules

cURL

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

200

{
  "hasMore": true,
  "items": [
    {
      "config": {},
      "contextId": "019c96a0-10a0-72d2-9fb0-2b7de8093182",
      "createdAt": "2025-01-15T10:30:00.000Z",
      "id": "019c96a0-1071-7a0d-9916-a831221de252",
      "priority": 1,
      "type": "EXACT",
      "updatedAt": "2025-01-15T10:30:00.000Z"
    }
  ],
  "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.

type · enum<string>

Filter by rule type

Available options: EXACT, TOLERANCE, DATE_LAG

Response

200

application/json

List of match rules with cursor pagination

Cursor-paginated list of match rules

hasMore · boolean

Example:

true

items · object[]

List of match rules

Show child attributes

limit · integer

Required range: 1 <= x <= 200

Example:

20

nextCursor · string

Example:

"eyJpZCI6IjEyMyJ9"

prevCursor · string

Example:

"eyJpZCI6IjEyMiJ9"