Overview

Base URL

All Partner API v2 requests use your Benefit Path host plus the /api/v2 prefix:

https://benefitpath.com/api/v2

Example discovery probe:

curl -s https://benefitpath.com/api/v2 | jq

What you can do today

• Calendar — list available dates, list slots, and create bookings.
• Analytics — list paths, then Path Analytics for a date range (or omit path_uuid for all paths).

Contacts and Appointments REST resources are on the roadmap and will appear under the same /api/v2 namespace when available.

Quick start

1. Get an API key from Integrations → API keys (see Authentication). Legacy calendar tokens still work.
2. Call availability for a date range, or fetch Path Analytics.
3. For bookings, pick a slot and POST a booking.

# Dates with open slots
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/calendar/availability?from=2026-07-20&to=2026-07-27"

# List paths (path_uuid catalog)
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/paths"

# Path Analytics for a date range (all paths)
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/analytics/paths?from=2026-07-01&to=2026-07-13"

# Book a slot
curl -s -X POST -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "date": "2026-07-21",
    "time": "14:30",
    "first_name": "Jane",
    "last_name": "Doe",
    "phone": "5551234567",
    "email": "jane@example.com"
  }' \
  "https://benefitpath.com/api/v2/calendar/bookings"

Response envelope

Successful responses use { "success": true, ... }. Errors use { "success": false, "error": "..." } with an appropriate HTTP status. See Errors.

Legacy paths

Existing integrations may still call /webhooks/book*. Those routes remain supported and share the same calendar logic as v2. Prefer /api/v2/calendar/* for new work.