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

Get contact

GET /api/v2/contacts/:contact_uuid - Fetch a single contact by UUID.

GET/api/v2/contacts/:contact_uuid

Fetch a single contact by UUID.

Required scope: contacts (or *).

Path parameters

NameRequiredDescription
contact_uuidYesContact UUID
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/contacts/c0a80101-0000-4000-8000-000000000001"
{
  "success": true,
  "contact": {
    "contact_uuid": "c0a80101-0000-4000-8000-000000000001",
    "first_name": "Jane",
    "last_name": "Doe",
    "email": "jane.doe@example.com",
    "phone_number": "5551234567"
  }
}

See Errors for the standard error envelope and rate limits.