Partner API
List contacts
GET /api/v2/contacts - Paginated contact list with optional search, tag filter, and trash mode.
GET
/api/v2/contactsPaginated contact list with optional search, tag filter, and trash mode.
Required scope: contacts (or *).
Query parameters
| Name | Required | Description |
|---|---|---|
page | No | Page number (default 1) |
limit | No | Page size |
search | No | Search query (alias: query) |
tag | No | Filter by tag |
mode | No | inbox (default) or trash |
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
"https://benefitpath.com/api/v2/contacts?page=1&limit=25&search=Jane&tag=medicare&mode=inbox"{
"success": true,
"contacts": [{
"contact_uuid": "c0a80101-0000-4000-8000-000000000001",
"first_name": "Jane",
"last_name": "Doe",
"email": "jane.doe@example.com",
"phone_number": "5551234567"
}],
"pagination": { "page": 1, "limit": 25, "total": 1 }
}See Errors for the standard error envelope and rate limits.