Skip to content

Availability

Compute open availability slots from schedules & appointments

Request

Returns available time slots based on schedules and existing appointments

Security
bearer
Path
siteIdstringrequired

Site identifier

Query
startDatestring

Start date for availability search

Example:startDate=2024-03-20
endDatestring

End date for availability search

Example:endDate=2024-03-21
practitionerIdstring

Filter availability by practitioner ID

includeScheduleboolean
Default:false
includePractitionerboolean
Default:false
includeLocationboolean
Default:false
curl -i -X GET \
  'https://docs.axiomera.com/_mock/apis/heydonto/openapi/site/{siteId}/availability?startDate=2024-03-20&endDate=2024-03-21&practitionerId=string&includeSchedule=false&includePractitioner=false&includeLocation=false' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Open availability slots computed from Schedules & Appointments

Bodyapplication/json
dataArray of objects(AvailabilitySlotDto)required

List of free timeslots within the requested date range

Response
{ "data": [ { … } ] }