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 users

GET /api/v2/users - Lists agents belonging to the agency.

GET/api/v2/users

Lists agents belonging to the agency.

Required scope: users (or *).

curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/users"
{
  "success": true,
  "users": [{
    "agent_uuid": "c0a80101-0000-4000-8000-000000000003",
    "role": "agent",
    "email": "agent@example.com",
    "first_name": "Alex",
    "last_name": "Rivera"
  }]
}

See Errors for the standard error envelope and rate limits.