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 path

GET /api/v2/paths/:slug - Fetch a path (including draft JSON) by slug.

GET/api/v2/paths/:slug

Fetch a path (including draft JSON) by slug.

Required scope: paths (or *).

Path parameters

NameRequiredDescription
slugYesPath slug or path_uuid
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/paths/medicare-quiz"
{
  "success": true,
  "path": {
    "path_uuid": "c0a80101-0000-4000-8000-000000000005",
    "slug": "medicare-quiz",
    "label": "Medicare Quiz",
    "path_json": { "pages": [], "logic": {}, "settings": {} }
  }
}

See Errors for the standard error envelope and rate limits.