List duplicate contacts

GET {{baseUrl}}/api/v1/groupContactDuplicateValues

This API lists the duplicate entries of a contact.The fieldName parameters is mandatory in the API request

Note:
If you encounter a 202 status code while executing this API request, it means there are 100,000 or more contacts in the help desk portal. Matching the records and finding duplicates will be time-consuming in such a scenario. Therefore, the deduplication request will be accepted, and after the process is completed, an automated report will be sent to the user who initiated the deduplication.

OAuth Scope

  • Desk.contacts.READ

Request Params

KeyDatatypeRequiredDescription
fieldNamestringName of the field whose values must be matched for deduplication.Values allowed are: <br>firstName,<br> <br>lastName,<br> <br>email,<br> <br>secondaryEmail,<br> <br>phone,<br> <br>fullName,<br> and <br>bothEmail.<br>
fromstringIndex number starting from which the contacts must be fetched
limitstringNumber of contacts to fetch
sortBystringKey that sorts the contacts by a specific attribute: count or fieldValue. The default sorting order is ascending. A - prefix denotes descending order of sorting
swFieldValuestringKey that specifies the letter with which the field values must start

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;data&quot;:[{&quot;count&quot;:16,&quot;fieldValue&quot;:&quot;Jade&quot;},{&quot;count&quot;:2,&quot;fieldValue&quot;:&quot;saran&quot;}]}