Get merge status

client.merge.getMerge(, ?): MergeGetMergeResponse { id, createdAt, duplicateId, 4 more }

GET/v1/merges/{id}

Returns the status and details of a merge operation by its ID.

Rate limit category: Read

ParametersExpand Collapse

id: string

The merge operation ID.

ReturnsExpand Collapse

MergeGetMergeResponse { id, createdAt, duplicateId, 4 more }

id: string

Unique identifier for the merge operation.

createdAt: string

ISO 8601 timestamp of when the merge was created.

duplicateId: string

ID of the record that was merged into the primary and soft-deleted.

entityType: string

The object type of the merged records (e.g. account, contact, opportunity, or a custom object slug).

primaryId: string

ID of the record that was kept (the primary).

status: string

Current status of the merge: cleanup_pending, done, or failed.

updatedAt: string

ISO 8601 timestamp of when the merge was last updated.

Get merge status

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const mergeGetMergeResponse = await client.merge.getMerge('id');

console.log(mergeGetMergeResponse.id);

{
  "id": "id",
  "createdAt": "createdAt",
  "duplicateId": "duplicateId",
  "entityType": "entityType",
  "primaryId": "primaryId",
  "status": "status",
  "updatedAt": "updatedAt"
}

Returns Examples

{
  "id": "id",
  "createdAt": "createdAt",
  "duplicateId": "duplicateId",
  "entityType": "entityType",
  "primaryId": "primaryId",
  "status": "status",
  "updatedAt": "updatedAt"
}