c5728da3037f

latestOpenAPI 3.0.32026-08-10601779.8 KB
Contacts

List contacts

Returns a paginated list of contacts (100 per page by default, up to 1000 via per_page).

Supports engagement filtering through filter[...] query parameters, so you can answer questions like "who last opened over a year ago" without paging the whole account. All filter conditions are AND-ed. Pass count_only=true to get just the number of matches — the cheapest way to size an audience before acting on it.

get/contacts

Query parameters

querystring

Search query for filtering contacts

unsubscribedboolean

Filter unsubscribed contacts

emailstring

Filter by specific email

per_pageinteger

Contacts per page

count_onlyboolean

Return only the number of matching contacts, with no contact records

filter[status]'active' | 'engaged' | 'inactive' | 'new' | 'unconfirmed' | 'unsubscribed' | 'bounced' | 'invalid'

Engagement status

filter[last_opened_after]string date-time

Contacts whose most recent open is on or after this date

filter[last_opened_before]string date-time

Contacts whose most recent open is before this date. Excludes contacts who never opened — use filter[never_opened] for those.

filter[last_clicked_after]string date-time

Contacts whose most recent click is on or after this date

filter[last_clicked_before]string date-time

Contacts whose most recent click is before this date

filter[last_sent_after]string date-time

Contacts last sent to on or after this date

filter[last_sent_before]string date-time

Contacts last sent to before this date

filter[created_after]string date-time

Contacts created on or after this date

filter[created_before]string date-time

Contacts created before this date

filter[never_opened]boolean

Only contacts who have never opened an email

filter[never_clicked]boolean

Only contacts who have never clicked a link

filter[never_sent]boolean

Only contacts who have never been sent an email

filter[in_list_ids]integer[]

Only contacts in any of these lists

filter[not_in_list_ids]integer[]

Exclude contacts in any of these lists

filter[tag_ids]integer[]

Only contacts carrying any of these tags

filter[not_tag_ids]integer[]

Exclude contacts carrying any of these tags

Response

Successful response

OR