Sign in
Appointments

Retrieve Appointment

get/api/2.0/appointments/{id}/

Path parameters

idinteger required

Response

appointment_type_idinteger nullable

The ID of an existing appointment type to assign to the appointment. Provide this instead of 'reason' to reference a specific appointment type rather than matching or creating one by name. If both 'reason' and 'appointment_type_id' are supplied, 'reason' takes precedence.

created_datestring date-time nullable
deleted_datestring date-time nullable
descriptionstring nullable
durationinteger

The duration of the appointment in minutes. If duration is not provided, the default duration will be used given a reason.

idinteger
instructionsstring nullable
is_blockingboolean
last_modified_datestring date-time
mode'IN_PERSON' | 'VIDEO'
patientinteger nullable required
physicianinteger required
practiceinteger required
reasonstring nullable
recurring_event_scheduleinteger nullable
scheduled_datestring date-time required
telehealth_detailsstring nullable
time_slot_type'appointment' | 'appointment_slot' | 'event'

Changes

No recorded changes to this endpoint across all 1 revision of this API.