v2
latestOpenAPI 3.0.02026-07-2632977728.5 KBRetrieve availability slots for the given date and office, doctor, or exam room.
If the exam_room parameter is not specified, the response will include availability for all exam rooms in the payload, grouped by exam room.
Example 1: Get availability for a single date
Request:
GET /api/availability?date=2026-01-29&office=338939&duration=30
Response:
{
"duration": 30,
"date": "2026-01-29",
"open_slots": [
{
"start": "09:00",
"end": "17:00",
"availability": [
{ "start": "09:00", "end": "09:30" },
{ "start": "09:30", "end": "10:00" },
{ "start": "10:00", "end": "10:30" }
]
}
],
"office": 338939
}
Example 2: Get availability for a date range
Request:
GET /api/availability?date_range=2026-01-29/2026-01-30&office=338939&duration=30
Response:
{
"date_range": ["2026-01-29", "2026-01-30"],
"duration": 30,
"office": 338939,
"dates": [
{
"date": "2026-01-29",
"open_slots": [
{
"start": "09:00",
"end": "17:00",
"availability": [
{ "start": "09:00", "end": "09:30" },
{ "start": "09:30", "end": "10:00" }
]
}
]
},
{
"date": "2026-01-30",
"open_slots": []
}
]
}
Example: Get availability for a specific exam room
Request:
GET /api/availability?date=2026-01-29&office=338939&duration=30&exam_room=2
Response:
{
"duration": 30,
"date": "2026-01-29",
"open_slots": [
{
"start": "09:00",
"end": "17:00",
"availability": [
{ "start": "09:00", "end": "09:30" },
{ "start": "09:30", "end": "10:00" },
{ "start": "10:00", "end": "10:30" }
]
}
],
"office": 338939,
"exam_room": 2
}
Query parameters
Office ID.
Office ID to filter availability.
Doctor ID.
Doctor ID to filter availability.
Date string.
Date for which to retrieve availability (YYYY-MM-DD).
Date range string.
Date range for which to retrieve availability (YYYY-MM-DD/YYYY-MM-DD).
Duration in minutes.
Duration of the appointment in minutes.
Exam room ID.
Exam room ID to filter availability. If not specified, availability for all exam rooms will be included.
Response
OK