Partner API
List appointments
GET /api/v2/appointments - Paginated appointment list for the agency that owns the token.
GET
/api/v2/appointmentsPaginated appointment list for the agency that owns the token.
Required scope: appointments (or *).
Query parameters
| Name | Required | Description |
|---|---|---|
page | No | Page number (default 1) |
limit | No | Page size |
from | No | Filter start (ISO or YYYY-MM-DD) |
to | No | Filter end (ISO or YYYY-MM-DD) |
status | No | Appointment status filter |
agent_uuid | No | Filter by assigned agent |
curl -s -H "Authorization: Bearer YOUR_TOKEN" \
"https://benefitpath.com/api/v2/appointments?page=1&limit=50&from=2026-07-01&to=2026-07-31&status=scheduled&agent_uuid=c0a80101-0000-4000-8000-000000000003"{
"success": true,
"appointments": [{
"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",
"status": "scheduled"
}],
"pagination": { "page": 1, "limit": 50, "total": 1 }
}See Errors for the standard error envelope and rate limits.