Skip to content

List Bookable Slots

Request

Retrieve available bookable slots for the practice group. Filter by location, practitioner, appointment type, and date range.

Typical flow: List Appointment Types → List Slots (filtered) → Create Appointment → Book Appointment.

Results are paginated. Use start_date and end_date query parameters to narrow the date window.

Security
apiKeyAuth and practiceGroupId
Query
location_idstring or Array of strings
Example:location_id=7
One of:

Filter slots by location. Pass a single ID or an array of IDs.

string
practitioner_idstring or Array of strings
Example:practitioner_id=15
One of:

Filter slots by practitioner. Pass a single ID or an array of IDs.

string
start_datestring

Only return slots on or after this date (ISO 8601 format).

Example:start_date=2026-03-15
end_datestring

Only return slots on or before this date (ISO 8601 format).

Example:end_date=2026-03-22
appointment_type_idstring or Array of strings
Example:appointment_type_id=42
One of:

Filter slots by appointment type. Pass a single ID or an array of IDs.

string
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/slots?location_id=7&practitioner_id=15&start_date=2026-03-15&end_date=2026-03-22&appointment_type_id=42' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
dataArray of objectsrequired
countnumberrequired
Response
{ "data": [ { … } ], "count": 0 }