Skip to main content
POST

Body

application/json
filters
FilterRule · object
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
Example:

1

page_size
integer
default:50

Number of results per page

Required range: 1 <= x <= 500
Example:

25

sort
string
default:-created_at

Field to sort by. Prefix with '-' for descending order.

Example:

"-created_at"

include_custom_fields
boolean
default:false

Whether to include custom fields on each returned contact. Defaults to false. Set true to include custom_field_<uuid> keys on each returned contact; GET /v1/contacts/{contact_id} always returns them.

Response

Successful Response

data
ContactResponse · object[]
required
pagination
PaginationInfo · object
required
meta
ResponseMeta · object