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 settings

GET /api/v2/settings - Returns curated agency settings safe for Partner API clients.

GET/api/v2/settings

Returns curated agency settings safe for Partner API clients.

Required scope: settings (or *).

curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/settings"
{
  "success": true,
  "settings": {
    "agency_name": "Acme Benefits",
    "primary_color": "#0b5fff",
    "secondary_color": "#112233",
    "owner_timezone": "America/New_York",
    "owner_phone": "5550001111"
  }
}

See Errors for the standard error envelope and rate limits.