v1

latestOpenAPI 3.0.12026-07-24116117186.3 KB
Contacts

Search for contacts

<br>Search for contacts. The method returns max 500 results.<br> The total amount of contacts is in the <b>TotalCount</b> header.

get/api/v1/contacts

Query parameters

externalCustomerIdstring

External contact ID

emailstring

Contact's email address

smsstring

Contact's phone number

firstnamestring

Contact first name

lastnamestring

Contact last name

startindexinteger

The number of the first contact returned in the search results.<br/>Numbering starts at 1

maxrowsinteger

Maximum number of returned contacts (max 500)

sortBystring

Possible value is 'contactId'. Only actual for searches without conditions. By default, the date of contact update is used for the search.<br>If this parameter is used, sorting is done by contactId. Using this parameter allows you to upload contacts faster.