Reach: Contacts
List profile contacts
Get a paginated list of contacts belonging to a profile.
Contacts can be filtered by subscription status, by tag, and by an email search term. The meta.total field of the response is the number of contacts matching the filters, so calling this endpoint without filters gives the profile's total contact count.
get/api/reach/v1/profiles/{profileUuid}/contacts
Path parameters
profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000
Profile uuid parameter
Query parameters
subscription_status'subscribed' | 'unsubscribed' | 'confirmed' | 'pending'
Example:subscribed
Filter contacts by subscription status
tag_uuidstring uuid
Example:550e8400-e29b-41d4-a716-446655440000
Filter contacts by tag UUID
searchstring
Example:john.doe@example.com
Search contacts by email
pageinteger
Example:1
Page number
per_pageinteger
Example:25
Number of items per page
Response
Success response
Example response
{
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "John",
"surname": "Doe",
"email": "john.doe@example.com",
"phone": "+14155552671",
"subscription_status": "subscribed",
"subscribed_at": "2023-01-01T00:00:00Z",
"unsubscribed_at": "2023-06-15T00:00:00Z",
"source": "api",
"note": "VIP customer"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}