Partner API
List messages
GET /api/v2/messages - Paginated inbox messages, optionally filtered by contact or unread status.
GET
/api/v2/messagesPaginated inbox messages, optionally filtered by contact or unread status.
Required scope: messages (or *).
Query parameters
| Name | Required | Description |
|---|---|---|
page | No | Page number (default 1) |
limit | No | Page size |
contact_uuid | No | Filter to one contact |
unread | No | Set to 1 for unread only |
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
"https://benefitpath.com/api/v2/messages?page=1&limit=25&contact_uuid=c0a80101-0000-4000-8000-000000000001&unread=1"{
"success": true,
"messages": [{
"id": 10042,
"contact_uuid": "c0a80101-0000-4000-8000-000000000001",
"is_read": false,
"message_text": "Thanks for calling back"
}],
"pagination": { "page": 1, "limit": 25, "total": 1 }
}See Errors for the standard error envelope and rate limits.