Person Merges

Get All Person Merge Tasks

Changed on

Retrieve paginated person merge tasks for the organization.

Returns all merge tasks initiated by users in your organization, including their current status, the persons involved, and task details.

You can filter tasks using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties:

Property NameTypeAllowed OperatorsExamples
statusenum=status=in-progress, status=success, status=failed

Tasks are returned in reverse chronological order (most recent first).

Requires the "Manage duplicates" permission and organization admin role.

get/v2/tasks/person-merges

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/tasks/person-merges
  • Auth
    HTTP bearer

Query parameters

cursorstring
Example:ICAgICAgYmVmb3JlOjo6Nw

Cursor for the next or previous page

limitinteger
Example:25

Number of items to include in the page

filterstring

Filter tasks using Affinity Filtering Language

Response

OK

Example response

{
  "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": {
    "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
    "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
  }
}

Changes

    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status