Openi DeveloperDeveloper

List matches

GET
/v1/matches

Authorization

ApiKeyAuth
x-api-key<token>

Tenant API key

In: header

Query Parameters

jobId?string

Filter by matching job ID

Formatuuid
recordId?string

Filter by related record (left or right)

Formatuuid
dataset?string

Filter by dataset name (either left or right record belongs to it)

decision?string

Value in

  • "MATCH"
  • "POSSIBLE"
  • "NO_MATCH"
minScore?number
from?string
Formatdate-time
to?string
Formatdate-time
page?integer
Formatint32
Range1 <= value
Default1
limit?integer
Formatint32
Range1 <= value <= 100
Default25
sortBy?string

Field to sort by

Default"createdAt"

Value in

  • "score"
  • "decision"
  • "createdAt"
sortOrder?string

Sort order

Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/matches"
{  "items": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "left_record_id": "ae43cecb-5238-49f1-b82e-12c9ea66d758",      "right_record_id": "4c477826-3a59-414b-b506-89db524eefbe",      "rule_set_id": "d9347d2e-8fc3-4254-806b-a802f013e519",      "score": 0,      "decision": "MATCH",      "explanation": {},      "matching_job_id": "9335edef-bc31-4f13-bb5d-53b72bf68d04",      "created_at": "2019-08-24T14:15:22Z"    }  ],  "page": 0,  "limit": 0,  "total": 0}