Skip to content

HeyDonto API Documentation (1.0)

API documentation for HeyDonto API

Overview
Languages
Servers
Mock server

https://docs.heydonto.com/_mock/apis/heydonto/openapi/

Sandbox

https://api-staging.heydonto.com/

Production

https://api.heydonto.com/

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

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.heydonto.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

data[].​scheduleIdstringrequired

The ID of the schedule resource that this timeslot references

Example: "123"
data[].​scheduleobject or nullrequired

Full FHIR Schedule resource (if requested/available)

data[].​practitionersArray of objects or nullrequired

List of Practitioner resources linked to the schedule (if any)

data[].​locationsArray of objects or nullrequired

List of Location resources linked to the schedule (if any)

data[].​startstringrequired

The start time (ISO8601) for the free slot

Example: "2025-01-01T09:00:00.000Z"
data[].​endstringrequired

The end time (ISO8601) for the free slot

Example: "2025-01-01T09:30:00.000Z"
Response
application/json
{ "data": [ {} ] }
Operations
Operations