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 appointment

GET /api/v2/appointments/:appointment_uuid - Fetch a single appointment by UUID.

GET/api/v2/appointments/:appointment_uuid

Fetch a single appointment by UUID.

Required scope: appointments (or *).

Path parameters

NameRequiredDescription
appointment_uuidYesAppointment UUID
 
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
  "https://benefitpath.com/api/v2/appointments/c0a80101-0000-4000-8000-000000000002"
{
  "success": true,
  "appointment": {
    "appointment_uuid": "c0a80101-0000-4000-8000-000000000002",
    "agent_uuid": "c0a80101-0000-4000-8000-000000000003",
    "contact_uuid": "c0a80101-0000-4000-8000-000000000001",
    "title": "Benefit consultation",
    "notes": "Follow up on plan options",
    "start_time": "2026-07-21 14:30:00",
    "end_time": "2026-07-21 15:00:00",
    "timezone": "America/New_York",
    "status": "scheduled"
  }
}

See Errors for the standard error envelope and rate limits.