Skip to main content
GET
List contacts

Autorisations

Authorization
string
header
requis

An API key from Settings > API keys. Scopes: business:read, business:write, calls:read, contacts:read, contacts:write, appointments:read, appointments:write, messages:read, knowledge:write, webhooks:manage.

Paramètres de requête

limit
integer

Items per page, 1 to 100. Defaults to 25.

Plage requise: 1 <= x <= 100
cursor
string

The next_cursor value from the previous page.

phone
string

Only the contact with this E.164 phone number.

email
string

Only contacts with this email address.

name
string

Only contacts whose name contains this text. Case does not matter.

Maximum string length: 200

Réponse

OK

data
object[]
requis
next_cursor
string | null
requis

Pass as cursor to get the next page. Null on the last page.

has_more
boolean
requis