Get merge status

merge.get_merge() -> MergeGetMergeResponse

GET/v1/merges/{id}

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

Rate limit category: Read

ParametersExpand Collapse

id: str

The merge operation ID.

ReturnsExpand Collapse

class MergeGetMergeResponse: …

id: str

Unique identifier for the merge operation.

created_at: str

ISO 8601 timestamp of when the merge was created.

duplicate_id: str

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

entity_type: str

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

primary_id: str

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

status: str

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

updated_at: str

ISO 8601 timestamp of when the merge was last updated.

Get merge status

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
merge_get_merge_response = client.merge.get_merge(
    "id",
)
print(merge_get_merge_response.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"
}