List Contacts

Your contacts, newest first, up to 100 per page (hasMore says whether another page exists). Filter by text, exact phone or email, a channel, or created/updated dates — updatedAfter makes an incremental sync cursor. Deleted contacts are never returned.

Security:

  • The organisationId in the URL must match the organisation your JWT was issued for — requests for a different organisation fail with 401.
  • Requires CRM_ADMIN, ACCOUNT_OWNER, or CRM_BOT role; other roles receive 403.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your organisation UUID (returned as org from the /token endpoint).

Query Params

Name, email or phone digits (contains).

string

Exact phone match on its digits (E.164 recommended). Matches numbers stored with or without the country code.

string

Exact email (case-insensitive).

string

Only contacts linked to a chat on this channel.

string
string
string

Changed at or after (sync cursors).

string
number
Defaults to 50

Page size (1–100).

number
Defaults to 0
Responses

400

Bad request — invalid filter

401

Unauthorized — invalid/expired JWT or organisation ID does not match the token

403

Forbidden — role not permitted

429

Too many requests

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json