Contacts
List contacts
Get a list of contacts for a specific org.
GET
List contacts
Authorizations
Bearer token authentication using your API key
Path Parameters
The ID of the org
Query Parameters
Free-text filter over contact name and channels.
Maximum string length:
256Whether the contact is unsubscribed
Search contacts by user ID match
Maximum string length:
128Search contacts by name match
Maximum string length:
256Search contacts by username match
Maximum string length:
256Search contacts by email match
Maximum string length:
256Search contacts by segment ID match
Maximum string length:
128Exclude admin contacts
Only contacts with this subscription status.
Available options:
ALL, SUBSCRIBED, UNSUBSCRIBED, BLOCKED, AI_REPLIES_OFF Page number
Number of items to take
Next page token (Only used on special endpoints)
Response
200 - application/json
Map of contact field key → value.
Deprecated: use fields. Same map, kept for compatibility.