Skip to content
API Docs/
API Reference
/
/
Get Appointment Status

Get Appointment Status

Request

Retrieves the status of an appointment by its ID, including the derived booking status and EHR partner status.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
curl -i -X GET \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/appointments/{id}/status' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE'

Responses

Ok

Bodyapplication/json
statusstringrequired
One of:
string
Enum:"reserved""confirmed""cancelled"
ehr_partner_statusstring or nullrequired
booking_mechanismstringrequired
Enum:"hero_confirmed""ehr_confirmed"
failure_reasonstring or nullrequired
failure_codestring or nullrequired
Response
{
  "status": "reserved",
  "ehr_partner_status": "string",
  "booking_mechanism": "hero_confirmed",
  "failure_reason": "string",
  "failure_code": "string"
}