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 — list path UUIDs, slugs, and labels for the agency that owns your token.

GET/api/v2/paths

Returns the agency path catalog. Use path_uuid values with the Path Analytics report endpoint.

Authenticate with a Bearer token that includes the analytics scope.

curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/paths"
{
  "success": true,
  "paths": [
    {
      "path_uuid": "a1b2c3d4-...",
      "slug": "my-path",
      "label": "My Path",
      "version": "3"
    }
  ]
}

Errors

  • 401 — missing or invalid Bearer token
  • 403 — token lacks the analytics scope

See Errors for the standard error envelope and rate limits.