Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json
limit
number
default:50

Maximum number of contacts to return.

Required range: 1 <= x <= 1000
skip
number
default:0

Number of records to skip for offset-based pagination.

Required range: x >= 0
sort_order
enum<string>
default:desc

Sort contacts by created_timestamp in ascending or descending order (newest first by default). Ties are broken by contact ID in the same direction.

Available options:
asc,
desc
pagination_key
string

Base64url-encoded pagination key from a previous response.

filter_criteria
object

Filter criteria for contacts. All conditions are implicitly connected with AND. first_name and last_name are not filterable here; use search_query to match on those.

search_query
string

Case-insensitive substring match against phone number, first name, last name, external ID, and custom field values. This is the only way to match on a contact's name.

excluded_contact_ids
string[]

Contact IDs to leave out of both the results and total.

Response

Paginated list of contacts.

has_more
boolean
required

Whether more results are available.

items
object[]
required
pagination_key
string

Pagination key for the next page.

total
number

Total count of contacts matching the filter.