Sign in

v1

latestSwagger 2.02026-08-06115129197.7 KB
Appointment

Get an appointment

Returns the appointment

get/appointments/{id}

Path parameters

idstring required

The appointments's id

Query parameters

id_is_partnerboolean required

true - id is partner_id / false - id is mytime id

include_eventsboolean

Include the events for the appointment. true/false

include_notesboolean

Include the notes for the appointment. true/false

include_custom_field_valuesboolean

Include the custom field values for the appointment. true/false

include_segment_employeesboolean

Include the segment_employees for each segment of the appointment. true/false

Headers

X-Subdomainstring

Merchant subdomain - Optional

Response

Appointment response

purchased_at_pricenumber
begin_atstring required
end_atstring required
client_namestring
client_emailstring
created_atstring
statusstring
time_zonestring
is_existing_customerstring
client_phonestring
variation_namestring
full_addressstring
employee_partner_idinteger
location_partner_idinteger
client_partner_idinteger
mytime_idstring
client_mobile_phonestring
client_home_phonestring
client_work_phonestring
checked_in_atstring
checked_instring
checked_out_atstring
pos_statusstring
address_idstring
employee_requestedstring
child_partner_idinteger
employee_mytime_idinteger required
location_mytime_idinteger required
client_mytime_idinteger required
child_mytime_idinteger
partner_idinteger
appointment_group_idinteger

ID of the appointment group this appointment belongs to, or null if it is not part of a group.

Example response

{
  "variations": [
    {
      "price": 120,
      "multiplier_base_price": 40,
      "price_multiplier": 3
    }
  ]
}