Skip to content
API Docs/
API Reference
/
/
Check slot availability

Check slot availability

Request

Check whether a specific slot is still available for booking. Call this immediately before creating an appointment to avoid reservation conflicts.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
practitioner_idstring^\d+$required
appointment_type_idstring^\d+$required
location_idstring^\d+$required
start_timestring, (date-time)required

ISO 8601 date format

Example:"1989-04-11"
durationnumberrequired
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/slots/availability \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "practitioner_id": "string",
    "appointment_type_id": "string",
    "location_id": "string",
    "start_time": "1989-04-11",
    "duration": 0
  }'

Responses

Ok

Bodyapplication/json
availablebooleanrequired
Response
{
  "available": true
}