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 invites

GET /api/v2/users/invites - Lists pending team invites.

GET/api/v2/users/invites

Lists pending team invites.

Required scope: users (or *).

curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/users/invites"
{
  "success": true,
  "invites": [{
    "email": "new.agent@example.com",
    "role": "agent",
    "first_name": "Sam",
    "last_name": "Lee"
  }]
}

See Errors for the standard error envelope and rate limits.