Skip to main content
GET
/
v2
/
person-merges
Get All Person Merges
curl --request GET \
  --url https://api.affinity.co/v2/person-merges \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 12,
      "status": "success",
      "taskId": "789e0123-e45b-67c8-d901-234567890123",
      "startedAt": "2025-06-03T10:30:00Z",
      "primaryPersonId": 12345,
      "duplicatePersonId": 67890,
      "completedAt": "2025-06-03T10:32:15Z",
      "errorMessage": null
    },
    {
      "id": 13,
      "status": "failed",
      "taskId": "456e7890-1234-5678-9012-345678901234",
      "startedAt": "2025-06-03T09:15:00Z",
      "primaryPersonId": 54321,
      "duplicatePersonId": 98765,
      "completedAt": "2025-06-03T09:16:30Z",
      "errorMessage": "Primary person not found"
    }
  ],
  "pagination": {
    "nextUrl": "https://api.affinity.co/v2/persons/merge?cursor=eyJpZCI6NDU2ZTc4OTAtZTEyYi0zNGM1LWQ2NzgtOTAxMjM0NTY3ODkwfQ==",
    "prevUrl": null
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

Cursor for the next or previous page

limit
integer<int32>
default:25

Number of items to include in the page

Required range: 1 <= x <= 100
filter
string

Filter person merges using Affinity Filtering Language

Response

OK

Paginated person merge states

data
PersonMergeState · object[]
required

Array of person merge states

Maximum array length: 100
pagination
Pagination · object
required
Example:
{
"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}