Skip to content

Run Duplicate Detection

POST
/duplicates/detection/run

Scan the org for duplicates of one record type now. Admin-only.

Rate-limited by the app to once per 15 minutes per record type (429 with the wait). Finds suggestions only - nothing is merged.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors duplicates.interfaces.router._RunDetectionRequest.

object
entity_type
required

What to scan.

string
Allowed values: contact company deal

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string