Person Merges

Get Person Merge Task

Changed on

Retrieve the status and details of a specific task for person merges.

Returns information about the person merges for a specific task including its overall status, number of merges in-progress, completed, and failed.

Detailed information about individual merges for this task can be found by querying: /v2/person-merges?filter=taskId={taskId} See Person Merges for more details.

Task statuses:

  • in-progress: The merge task is currently being processed.
  • success: The merge task completed successfully.
  • failed: The merge task failed.

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

get/v2/tasks/person-merges/{taskId}

Request

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

Path parameters

taskIdstring uuid required
Example:123e4567-e89b-12d3-a456-426614174000

Person merge task ID

Response

OK

idstring uuid required

The unique identifier for this merge task

status'in-progress' | 'success' | 'failed' required

The current status of the batch operation

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "in-progress",
  "resultsSummary": {
    "total": 5,
    "inProgress": 2,
    "success": 2,
    "failed": 1
  }
}

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