Skip to navigation

List contacts

Returns the contacts of the account, 20 on each page. The list includes only contacts with an email address, a phone number, or an identifier.

Authentication

api_access_tokenstring

An API key that an administrator creates in Settings > Developer. The personal access token of a user does not work. A key reaches every inbox, conversation, and contact in the account that created it, and nothing in other accounts.

Path parameters

account_idintegerRequired

The id of your account. It is the number after /accounts/ in the dashboard URL.

Query parameters

pageintegerOptionalDefaults to 1

The page number. The first page is 1.

labels[]list of stringsOptional
Return only contacts with 1 of these labels.
sortstringOptional

The sort order. The values are name, email, phone_number, last_activity_at, created_at, company_name, city, and country. Put - before the value for the reverse order.

Response

A page of contacts.
metaobjectOptional
payloadlist of objectsOptional

Errors

401
Unauthorized Error