List contacts

get

https://api.ycloud.com/v2/contact/contacts

Returns a paginated list of contacts.

Omit pageAfter to use the existing page-based pagination. To use forward cursor pagination, set pageAfter=0 for the first page, then pass the exact cursor.after value returned by the previous response. Cursor results are ordered by contact ID in ascending order.

Do not combine pageAfter with page, pageBefore, offset, or sort. Keep all filters unchanged while following a cursor. Concurrent contact inserts, deletions, or filter-field updates use weak consistency; restart a full traversal with pageAfter=0 when a fresh snapshot is required.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

page

int32

1 to 100

Defaults to 1

Page number of the results to be returned, 1-based.

limit

int32

1 to 100

Defaults to 10

A limit on the number of results to be returned, or number of results per page, between 1 and 100, defaults to 10.

includeTotal

boolean

Defaults to false

Return results inside an object that contains the total result count or not.

pageAfter

string

^[0-9]+$

Contact ID cursor for forward pagination. Use 0 to start a new cursor traversal. For each subsequent page, pass the exact cursor.after value from the previous response.
The value must be a non-negative decimal integer in the signed 64-bit range (0 through 9223372036854775807). It cannot be combined with page, pageBefore, offset, or sort.

filter.tags

string

Comma-separated list of tag names. If any tag does not exist, the request fails with a parameter error.

filter.countryCode

string

Two-letter country abbreviation. See ISO 3166-1 alpha-2 country code.

filter.phoneNumber

string

Phone number in E.164 format.

filter.email

string

The contact's email address.

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved a paginated list of objects.

400One or more query parameters are invalid, including an invalid cursor, incompatible pagination parameters, an out-of-range limit, or an unknown tag.