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 booking widget

GET /api/v2/booking-widgets/:widget_uuid - Fetch a single booking widget by UUID.

GET/api/v2/booking-widgets/:widget_uuid

Fetch a single booking widget by UUID.

Required scope: appointments (or *).

Path parameters

NameRequiredDescription
widget_uuidYesWidget UUID
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/booking-widgets/c0a80101-0000-4000-8000-000000000004"
{
  "success": true,
  "widget": { "widget_uuid": "c0a80101-0000-4000-8000-000000000004", "slug": "book-me", "label": "Book a call" }
}

See Errors for the standard error envelope and rate limits.