Get appointment slots
GET/api/diary/groupedfreeslots
Retrieves an array of grouped free appointment slots by siteId, visitTypeId, fromDate and toDate.
Response sample
{
"id": "string",
"type": "string",
"bookingRuleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"bookingHorizonPeriodReached": true,
"freeSlots": [{
"date": "2025-04-29",
"timePeriods": [{
"caption": "string",
"startTime": "00:00:00",
"endTime": "00:00:00",
"freeSlots": [{
"patientDoubleBooked": true,
"startTime": "2025-04-29T09:14:18.851Z",
"bookingDetails": [{
"bookingDuration": 0,
"slotDuration": 0,
"doctorId": "string",
"diaryId": "string" }]}]}]}]
}
Request
Responses
- 200
- 400
- 404
Success: Request accepted.
Bad request: StorefrontOrigin not passed in header; the request wasn’t valid or can’t be otherwise served. Typical when there is a syntax error in the request. Further details of the error are provided in the response payload body.
Not found: The Omni Subscription is not assigned to the site group; the URI isn’t valid or the requested resource doesn’t exist.