Sign in
appointments

Get appointment by ID

Get a single appointment by ID.

get/api/appointments/{appointment_id}

Path parameters

appointment_idstring required

Query parameters

with_detailsboolean

Include full joins (operator, patient)

Include full joins (operator, patient)

Response

Successful Response

idstring required
patient_idstring required
operator_idstring required
appointment_datetimestring required
duration_secondsinteger required
statusstring required
appointment_type_codestring required
locationstring required
expert_in_personboolean nullable
meeting_linkstring nullable
payment_statusstring nullable
paid_with_couponboolean nullable
patient_costnumber nullable
operator_costnumber nullable
notesstring nullable
notes_updated_atstring nullable
payment_idstring nullable
payment_completed_atstring nullable
payment_methodstring nullable
stripe_checkout_session_idstring nullable
is_tax_deductibleboolean nullable
consent_presentboolean nullable
consent_validboolean nullable
created_atstring required
operatorobject nullable
patientobject nullable
joint_operator_first_namestring nullable

Other expert's first name when a joint appointment is collapsed into one row

joint_operator_last_namestring nullable

Other expert's last name when a joint appointment is collapsed into one row

Changes

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