List duplicate groups
Returns groups of records that match a custom duplicate rule. Records are grouped when they share identical values for the properties defined in the rule. Supports three lookup modes: list all groups for a rule (ruleId), retrieve a specific group (ruleId + groupId), or find all groups containing a specific record (objectId).
Supported products
Supported products
Query Parameters
A pagination cursor returned in a previous response. Pass this value to retrieve the next page of results.
The ID of a specific group to retrieve. Requires ruleId.
The maximum number of groups to return per page. Defaults to 10, maximum 100. Only applies when listing groups by ruleId.
Returns all groups that contain this record.
The maximum number of records to return per group. Defaults to 10, maximum 100.
The type of records to retrieve groups for, such as contacts or companies. Required.
The ID of the custom duplicate rule to retrieve groups for. Required when using groupId.
Response
successful operation