List Contacts

List contacts for the given workspace. By default, only identified contacts are shown so you won't see anonymous or GDPR-redacted contacts.

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

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

string
enum

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

Allowed:
string
enum

Sort property of a list response. The default is id and thus the created_at order.
If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Allowed:
filter
object

Filter by available properties in query params, like this: api/v2/resources?filter[id]=value&filter[another_property]=value1,value2. Check our Filtering guide for examples and all about filtering here.

string

The id (integer) or public_id (string) of a saved Refine::StoredFilter scoped to this workspace. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters (with save: true) or by the RefineFilter endpoints. Applies the saved filter's criteria to the results, composed (AND) with any filter[…] params.
Returns 422 if the filter is unknown, invalid, or belongs to a different workspace. When both stored_filter_id and stable_id are supplied, stable_id takes precedence.

string

A URL-encoded Refine stable_id token — the standard gzip+base64 full-state format used by both the contacts/filters API endpoint and the server-rendered filter UI, making the tokens interoperable. Returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters in the stable_id field. Applies the encoded filter criteria to the results, composed (AND) with any filter[…] params.
Returns 422 if the token is not a valid Refine stable_id, is not a ContactsFilter, or uses grouped/nested or or conditions disallowed by the public-API SafeConditionPolicy. When both stored_filter_id and stable_id are supplied, stable_id takes precedence.

expand[]
array of strings

Expand additional data in the response. Use expand[]=field_name to include optional fields (e.g., expand[]=email_engagement). See the Expanding guide for available fields and examples.

expand[]
Allowed:
Responses

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