List contacts

Returns a paginated list of contacts filtered by the provided query parameters.

Scopes: contacts.read

Filter restrictions:

  • tag and status cannot be used together in the same request.
  • updatedAtFrom cannot be combined with email, phone, status, segmentID, or tag.
Query Params
integer
1 to 250

Number of items per page. Range: 1-250. Default: 100

string

Opaque cursor for fetching the next page (from paging.cursors.after)

string

Opaque cursor for fetching the previous page (from paging.cursors.before)

string
enum

Sort field. Default: createdAt

Allowed:
string
enum

Sort direction. Default: desc

Allowed:
string

Filter by email address

string

Filter by phone number

string
enum

Contact subscription status filter. Cannot be combined with tag

Allowed:
string

Filter by segment ID

string

Filter by tag. Cannot be combined with status

string

Filter contacts updated at or after this RFC3339 timestamp. Cannot be combined with email, phone, status, segmentID, or tag

Headers
string
required
Defaults to 2026-03-15

API version that specifies the response format and behaviour

Responses

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