List contacts

Returns your contacts one page at a time. Each item has the same shape as GET /contacts/{contactId}.

To walk every contact, call without cursor, then keep passing the previous response's nextCursor as cursor until hasMore is false (nextCursor is null). Keep the other query parameters the same for the whole walk. Treat the cursor as opaque: it is signed, and only works for the same account and the same filters. Any other cursor is rejected with 33045.

Filters. groupId, tagId (requires groupId), createdAfter (inclusive) and createdBefore (exclusive) can be combined. Results are newest first. Contacts created after the first page are not included — start a new walk to pick them up.

Changes since a time. With updatedAfter, the endpoint returns contacts created or changed since that time, oldest change first, and the response includes updatedUntil. Pass that value as updatedAfter on your next sync to get only what changed in between; a contact may appear in two consecutive syncs. updatedAfter cannot be combined with other filters. Deleted contacts are not returned in either mode.

There is no total count.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
number
1 to 100
Defaults to 50

Page size — maximum number of contacts in results.

string

The previous page's nextCursor. Omit for the first page. Treat it as opaque — it only works for the same account and the same groupId.

string

Group ID (grp_...). Only contacts that are active members of this group.

string

Tag ID (tag_...). Only contacts carrying this tag in the group. Requires groupId — a tag belongs to one group.

string

Only contacts created at or after this time (inclusive). ISO 8601 or a date.

string

Only contacts created before this time (exclusive). A date (UTC) or an ISO 8601 datetime with a timezone.

string

Changes mode: only contacts updated at or after this time, oldest change first. Pass the previous sync's updatedUntil here. Cannot be combined with other filters.

Responses

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