Get an Appointment

Request

Retrieves an appointment by its ID.

Security

apiKeyAuth and practiceGroupId

Path

idstringrequired

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

Responses

Ok

Bodyapplication/json

idstring^\d+$required

patient_idstring or null^\d+$

practitioner_idstring^\d+$required

location_idstring^\d+$required

appointment_type_idstring^\d+$required

durationnumber, >= 1

start_timestring or null, (date-time)required

videoboolean

Default:false

in_personboolean

Default:false

telephoneboolean

Default:false

video_urlstring or null

link_idstring or null

reserved_untilstring or null, (date-time)

booking_confirmed_atstring or null, (date-time)

can_be_cancelledboolean

Default:false

can_be_rescheduledboolean

Default:false

cancellation_policy_hoursnumber

suppress_mailboolean

Default:false

reasonstring or nullrequired

appointment_template_namestring or nullrequired

location_namestring or nullrequired

appointment_sourcestring or nullrequired

booking_mechanismstringrequired

Enum:"hero_confirmed""ehr_confirmed"

booking_statusstringrequired

Enum:"reserved""pending""confirmed""cancelling""rescheduling""abandoned""cancelled""failed""unknown"

cancelled_atstring or null, (date-time)required

patientobject or null

practitionerobject or null

Response

{
  "id": "string",
  "patient_id": "string",
  "practitioner_id": "string",
  "location_id": "string",
  "appointment_type_id": "string",
  "duration": 1,
  "start_time": "2019-08-24T14:15:22Z",
  "video": false,
  "in_person": false,
  "telephone": false,
  "video_url": "string",
  "link_id": "string",
  "reserved_until": "2019-08-24T14:15:22Z",
  "booking_confirmed_at": "2019-08-24T14:15:22Z",
  "can_be_cancelled": false,
  "can_be_rescheduled": false,
  "cancellation_policy_hours": 0,
  "suppress_mail": false,
  "reason": "string",
  "appointment_template_name": "string",
  "location_name": "string",
  "appointment_source": "string",
  "booking_mechanism": "hero_confirmed",
  "booking_status": "reserved",
  "cancelled_at": "2019-08-24T14:15:22Z",
  "patient": {
    "id": "string",
    "title": "Baron",
    "first_name": "string",
    "last_name": "string"
  },
  "practitioner": {
    "id": "string",
    "title": "Baron",
    "first_name": "string",
    "last_name": "string"
  }
}