v1

latestOpenAPI 3.0.02026-07-14315757.3 KB

Contacts

Search contacts

This API endpoint retrieves all the saved contacts by particular filter(s)

post/api/v1/contacts/contact/search

includeCountboolean

includes the amount of the contacts. The value “true” can slow down the performance of the request. Default - false.

pageSizenumber

how many records to return per page (default 10, max 500)

pageNumbernumber

an integer that allows you to paginate through the results (default 1)

sortstring

a property to sort the contacts by

order'ASC' | 'DESC'

can be ASC or DESC

includeRelationsboolean

Includes companies, owner and lists in each of contacts. The value “true” can slow down the performance of the request. Default - false

includesstring[]

Company fields(domain, name and etc.)

deletedboolean

Returns only deleted contacts if true. Default - false.

searchIdstring

Entity given