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 paths

GET /api/v2/paths - Returns the agency path catalog. With paths scope you get the full paths list; with analytics only, a thinner list suitable for Path Analytics.

GET/api/v2/paths

Returns the agency path catalog. With paths scope you get the full paths list; with analytics only, a thinner list suitable for Path Analytics.

Required scope: paths or analytics (or *).

curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/paths"
{
  "success": true,
  "paths": [
    {
      "path_uuid": "c0a80101-0000-4000-8000-000000000005",
      "slug": "medicare-quiz",
      "label": "Medicare Quiz",
      "version": "3"
    }
  ]
}

Use path_uuid values with the Path Analytics report.

  • 401 - missing or invalid Bearer token
  • 403 - token lacks paths or analytics

See Errors for the standard error envelope and rate limits.