Skip to main content
GET
/
v2
/
tasks
/
person-merges
Get All Person Merge Tasks
curl --request GET \
  --url https://api.affinity.co/v2/tasks/person-merges \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "success",
      "resultsSummary": {
        "total": 1,
        "inProgress": 0,
        "success": 1,
        "failed": 0
      }
    },
    {
      "id": "456e7890-e12b-34c5-d678-901234567890",
      "status": "failed",
      "resultsSummary": {
        "total": 1,
        "inProgress": 0,
        "success": 0,
        "failed": 1
      }
    }
  ],
  "pagination": {
    "nextUrl": "https://api.affinity.co/v2/tasks/person-merges?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

Example:

"ICAgICAgYmVmb3JlOjo6Nw"

​
limit
integer<int32>
default:25

Number of items to include in the page

Required range: 1 <= x <= 100
Example:

25

​
filter
string

Filter tasks using Affinity Filtering Language

Response

OK

Paginated person merge tasks

​
data
PersonMergeTask · object[]
required

Array of person merge tasks

Maximum array length: 100
Example:
[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "success",
    "resultsSummary": {
      "total": 1,
      "inProgress": 0,
      "success": 1,
      "failed": 0
    }
  },
  {
    "id": "456e7890-e12b-34c5-d678-901234567890",
    "status": "failed",
    "resultsSummary": {
      "total": 1,
      "inProgress": 0,
      "success": 0,
      "failed": 1
    }
  }
]
​
pagination
Pagination · object
required
Example:
{
  "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
  "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}