Skip to main content
GET
List Contacts

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Query Parameters

tag
string

Only contacts carrying this tag. Normalised as tags are stored — Hot Lead matches hot-lead.

group
string

Only contacts in this contact group, grp_….

externalId
string

Only the contact with this CRM id.

phone
string

Only the contact on this number, with its country code, in any format a person would type it (+91 98765 43210, +44 7700 900123).

limit
integer
default:25

How many items to return, 1 to 100.

Required range: 1 <= x <= 100
cursor
string

The nextCursor from the previous page. Leave it out for the first page.

Response

A page of contacts.

items
object[]
required
nextCursor
string | null
required

Pass as cursor for the next page. Null on the last page.