Sign in

v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB
Configuration Match Rules

Get a match rule

Use this endpoint to retrieve the details of a specific match rule by its identifier.

get/v1/contexts/{contextId}/rules/{ruleId}

Path parameters

contextIdstring required

The unique identifier of the reconciliation context.

ruleIdstring required

The unique identifier of the match rule.

Headers

X-Request-Idstring

A unique identifier for tracing the request across services.

Response

Successfully retrieved match rule

configobject

Rule configuration

contextIdstring

Context ID this rule belongs to

createdAtstring

Creation timestamp in RFC3339 format

idstring

Unique identifier for the rule

priorityinteger

Execution priority (lower = higher priority)

type'EXACT' | 'TOLERANCE' | 'DATE_LAG'

Type of matching rule

updatedAtstring

Last update timestamp in RFC3339 format

Example response

{
  "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"
}