v1

latestOpenAPI 3.0.02026-08-0645062.8 KB

Search contacts

Search contacts based on various parameters. Requires a valid Bearer token.

get/contacts/search

Query parameters

emailstring

Email address to search for (partial match)

phonestring

Phone number to search for (partial match)

descriptionstring

Description to search for (partial match)

first_namestring

First name to search for (partial match)

last_namestring

Last name to search for (partial match)

titlestring

Title to search for (partial match)

groupIdstring

Group ID to filter by (required)

stageIdstring

Stage ID to filter by (exact match)

priorityIdstring

Priority ID to filter by (exact match)

Response

Successful search

group_idstring
entity_base_idstring
entity_type_idinteger
phone_book_dataobject