Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
organisation_id | integer | Yes | Organisation to retrieve slots for |
start | datetime | Yes | Return slots from this date |
end | datetime | Yes | Return slots up to this date |
appointment_type_id | integer | No | Appointment type to find availability for |
provider_ids | array[integer] | No | Provider person IDs to filter on |
Path Parameters
No path parameters
Header Parameters
No header parameters
Responses
200 — OK
Always returns, even when there are no booked slots in the range.
{
"slots": [
{
"id": 1023,
"start": "2023-07-27T06:30:00+00:00",
"end": "2023-07-27T07:00:00+00:00",
"appoinment_type_id": 3,
"provider_ids": [42],
"patient_ids": [881]
}
]
}422 — Unprocessable Entity
Query parameter validation failure (e.g. missing required param, wrong type).
429 — Too Many Requests
Rate limit exceeded.