List Contacts

Get a list of contacts.

Pagination. Every response carries paginator.nextCursor. To get the next page, send it
back as cursor together with the same filters; it is null on the last page. Following
nextCursor reaches every contact, however many there are.

page is still accepted, but it only reaches the first 10,000 contacts: a page past that
returns no contacts. paginator.totalItemsCount is capped at 10,000 for the same reason.
Use cursor to go further.

Order. Without a search filter (fsf_query, name, email or phone_number)
contacts are returned oldest first. With a search filter they are ordered by name; there,
the nextCursor of a page fetched without a cursor may return again the contacts already
returned that share a name with the last contact of that page (up to a page of them when a
search matches many contacts of the same name), but it never skips one. Deduplicate on id
and channel_id when you need each contact once.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Fulltext string search query

int64

Filter by Consumer ID

string

Filter by email

string

Filter by full name

string

Filter by phone number

string

The paginator.nextCursor of the previous page. It must be sent with the same filters as the request that returned it, and cannot be combined with page.

integer
≥ 1

Page number, starting at 1. Only reaches the first 10,000 contacts; use cursor to go further. A value below 1 is read as 1, and a page past the last one returns the last page.

integer
1 to 1000
Defaults to 20

Number of contacts per page. A value above 1000 is read as 1000; a value below 1 as the default.

Responses

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