v1

latestOpenAPI 3.1.0Proprietary2026-07-134247109.0 KB
Contacts

List contacts

Plan: Pro. At least one filter parameter is required.

get/contacts

Query parameters

company_idstring uuid

Company id.

activeboolean

Active flag.

namestring

Contact name.

searchstring

Search in name or email.

with_emailstring

If present, only contacts that have an email.

cportalboolean

Customer-portal-enabled contacts.

pageinteger
per_pageinteger

Capped to 5 when the account lacks the index_api_enabled flag.

Response

OK