companies

Propose pairs of records that look like the same record

Propose pairs of records that look like the same record, ranked by how alike their names are and whether they share a relationship. Works on companies, contacts, and a type this workspace defined. It PROPOSES only: nothing here merges anything, and the merge tools still require you to name both ids. Use it on a type with a declared identity too: the key cannot collide, so what is left to find is one person entered twice under two different keys. Walks the workspace a page at a time; pass the returned cursor to continue.

get/v1/duplicates

Request

  • Base URL: https://api.indraft.io
  • URL: https://api.indraft.io/v1/duplicates
  • Auth: HTTP bearer

Query parameters

objectTypestring required

What is being surveyed: a canonical type (company, contact), or the key of a type this workspace defined. A workspace's own type is surveyed on its first indexed text field, which is the name the search index holds for it.

limitinteger

How many to return. The page bound is published in the schema call, and asking for more is refused rather than quietly truncated.

cursorstring

The opaque marker from the previous page. Store it and hand it back; do not parse it. A cursor is only ever emitted when another row really exists, so a page you were given is never empty.

Response

Success

nextCursorstring required
examinedinteger required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.