Appointments API
Read the appointments booked through Velaro.
Base URL: https://api-admin-us-east.velaro.com/api/v1. Send your API key as Authorization: Bearer vlk_.... Create keys under Settings > API Keys; each key carries only the scopes you grant it.
Get appointment
GET /api/v1/appointments/{id}
Required scope: read:appointments
| Parameter | In | Type | Notes |
|---|---|---|---|
| id | path | integer (int32) | required |
Response: JSON AppointmentDto
List appointments
GET /api/v1/appointments
Required scope: read:appointments
| Parameter | In | Type | Notes |
|---|---|---|---|
| status | query | string | optional |
| from | query | string (date-time) | optional |
| to | query | string (date-time) | optional |
| page | query | integer (int32) | optional, default 1 |
| pageSize | query | integer (int32) | optional, default 50 |
Response: JSON list of AppointmentDto
Common responses: 401 for a missing or invalid key, 403 when the key lacks the scope, 429 when the rate limit is reached.
Was this article helpful?