GET/v1/emails/contacts

Authorization

Bearer token

Authorizationrequiredheader

Send your API key as Bearer YOUR_API_KEY.

Permissionemail.full_access

Query parameters

pageoptionalinteger

Page number, starting at 1. Default 1.

limitoptionalinteger

1–100. Default 50.

searchoptionalstring

Match contacts by email or name.

emailStatusoptionalstring

One of"subscribed""unsubscribed"

listIdoptionalstring

Only contacts in this list.

segmentIdoptionalstring

Only contacts in this segment.

Response

application/json200 OK

Results are under data, with page-based pagination.

itemsarray

Contacts on this page, each with id, email, names, phone_number, email_status, and created_at.

totalnumber

Contacts matching the filters.

pagenumber

The page returned.

limitnumber

The page size.

Nexiom Connect
Open dashboard