Search Duplicate Records

POST 
/objects/:schemaKey/records/search/duplicate

Search Duplicate Records

Request

Version stringrequired

API Version

Available options2023-02-21

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix; standard objects use their own key, e.g. business.email for a company’s email.

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location ID

propertiesobjectrequired

Properties to check for duplicates

Example (auto)

{
  "locationId": "ve9EPM428h8vShlRW1KT",
  "properties": {
    "name": "Test Name",
    "email": "[email protected]"
  }
}

application/json

Successful response

application/json

Schema

Schema

existsbooleanrequired

Whether a duplicate record exists

recordobject

The duplicate record if found

matchingFieldsstring[]

Names of fields that matched

Example (auto)

{
  "exists": true,
  "record": {
    "id": "661c06b4ffde146bdb469442",
    "properties": {
      "name": "Test Name",
      "email": "[email protected]"
    }
  },
  "matchingFields": [
    "name",
    "email"
  ]
}