Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-2687313591.4 KB
Person Merges

Get Person Merge

Retrieve the status and details of a specific person merge.

Returns information about the person merge including its current status, the persons involved, timestamps, and any error information if the merge failed.

The mergeId can be obtained from the response of the Get All Person Merges endpoint, or by filtering person merges by task ID using /v2/person-merges?filter=taskId={taskId} after initiating a merge.

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

get/v2/person-merges/{mergeId}

Path parameters

mergeIdinteger required
Example:12345

Person merge ID

Response

OK

idinteger required

The unique identifier for the merge

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

Current status of the merge

taskIdstring uuid required

Identifier for the task this merge belongs to

startedAtstring date-time required

Timestamp when the merge started

primaryPersonIdinteger required

ID of the primary person that other profiles were merged into

duplicatePersonIdinteger required

ID of the duplicate person that was merged into the primary person

completedAtstring date-time nullable required

Timestamp when the merge completed (success or failure)

errorMessagestring nullable required

Error message if the merge failed

Example response

{
  "id": 12345,
  "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": "Primary person not found"
}