List contacts
Page through your contacts, with search and filters for subscription status, list, and segment.
GET
/v1/emails/contactsAuthorization
Bearer token
- Authorizationrequiredheader
Send your API key as
Bearer YOUR_API_KEY.
Query parameters
pageoptionalintegerPage number, starting at
1. Default1.limitoptionalinteger1–100. Default
50.searchoptionalstringMatch contacts by email or name.
emailStatusoptionalstringOne of
"subscribed""unsubscribed"listIdoptionalstringOnly contacts in this list.
segmentIdoptionalstringOnly contacts in this segment.
Response
application/json200 OK
Results are under data, with page-based pagination.
itemsarrayContacts on this page, each with
id,email, names,phone_number,email_status, andcreated_at.totalnumberContacts matching the filters.
pagenumberThe page returned.
limitnumberThe page size.