Pardon our mess These API docs are a work in progress. Endpoints, examples, and behavior may change as we continue to develop the Partner API v2.

Partner API

List messages

GET /api/v2/messages - Paginated inbox messages, optionally filtered by contact or unread status.

GET/api/v2/messages

Paginated inbox messages, optionally filtered by contact or unread status.

Required scope: messages (or *).

Query parameters

NameRequiredDescription
pageNoPage number (default 1)
limitNoPage size
contact_uuidNoFilter to one contact
unreadNoSet 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.