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 slots for a date

GET /api/v2/calendar/availability/:date - Returns open time slots for a specific day. Slot strings are HH:MM wall-clock times in the calendar timezone.

GET/api/v2/calendar/availability/:date

Returns open time slots for a specific day. Slot strings are HH:MM wall-clock times in the calendar timezone.

Required scope: calendar (or *).

Path parameters

NameRequiredDescription
dateYesYYYY-MM-DD

Query parameters

NameRequiredDescription
agent_uuidNoOptional team member (fixed-mode calendars)
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/calendar/availability/2026-07-21?agent_uuid=c0a80101-0000-4000-8000-000000000003"
{
  "success": true,
  "date": "2026-07-21",
  "timezone": "America/New_York",
  "agent_uuid": "c0a80101-0000-4000-8000-000000000003",
  "slots": ["09:00", "09:30", "10:00", "14:30"]
}

See Errors for the standard error envelope and rate limits.