appointments

Get appointment by ID

Changed on

Get a single appointment by ID.

get/api/appointments/{appointment_id}

Request

  • Base URL: https://api.corabea.it (the document declares no server; this is the origin it was published from)
  • URL: https://api.corabea.it/api/appointments/{appointment_id}
  • Auth: HTTP bearer

Path parameters

appointment_idstring required

Query parameters

with_detailsboolean

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
call_modality'phone' | 'video' nullable
locationstring required
expert_in_personboolean nullable
meeting_linkstring nullable
payment_statusstring nullable
paid_with_couponboolean nullable
payment_discount_codestring nullable

Readable coupon or promotion code used for a paid introductory call

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
is_familyboolean
is_valuationboolean
has_historyboolean

Whether the appointment has status, reschedule or payment history events

refund_pendingboolean

A refund was requested and Stripe has not confirmed it yet

created_atstring required
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

joint_legsAppointmentFlatResponse[] circular

Changes