Reach: Contacts
List contacts
Get a list of contacts, optionally filtered by group and subscription status.
This endpoint returns a paginated list of contacts with their basic information. You can filter contacts by group UUID and subscription status.
get/api/reach/v1/contacts
Query parameters
group_uuidstring
Example:550e8400-e29b-41d4-a716-446655440000
Filter contacts by group UUID
subscription_status'subscribed' | 'unsubscribed'
Example:subscribed
Filter contacts by subscription status
pageinteger
Example:1
Page number
Response
Success response
Example response
{
"data": [
{
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "John",
"surname": "Doe",
"email": "john.doe@example.com",
"subscription_status": "subscribed",
"subscribed_at": "2023-01-01T00:00:00Z",
"source": "sync",
"note": "VIP customer"
}
],
"meta": {
"current_page": 1,
"per_page": 15,
"total": 100
}
}