v1

latestSwagger 2.02026-08-06115129197.7 KB
Appointment

Get all appointments

Returns all appointments from a specific location

get/appointments

Query parameters

location_partner_idstring

Filter appointments by location using the partner (external) id

location_mytime_idstring

Filter appointments by location using the mytime id

employee_mytime_idstring

Filter appointments by Employee mytime ID

client_mytime_idstring

Filter appointments by Client mytime ID

for_waitlistboolean

Return only the appointments from the waitlist

start_datestring

The start_date for the appointments. Accepts YYYY-MM-DD or ISO 8601 datetime in UTC; datetimes without an offset are assumed to be UTC. Default: Yesterday at 00:00:00 UTC. e.g.: 2017-10-22 or 2017-10-22T00:00:00

end_datestring

The end_date for the appointments. Accepts YYYY-MM-DD or ISO 8601 datetime in UTC; datetimes without an offset are assumed to be UTC. Default: Today at 00:00:00 UTC. e.g.: 2017-10-23 or 2017-10-23T00:00:00

created_start_datestring

The created_start_date for the appointments. e.g.: 2017-10-22 . created_end_date is required for this to work

created_end_datestring

The created_end_date for the appointments. e.g.: 2017-10-22 . created_start_date is required for this to work

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

limitinteger

The number of results in the response. Values above 100 are capped at 100. When omitted, the default page size is applied.

offsetinteger

The number of results to offset the response by. Eg. If the offset is 100, then the response would start at the 101st item

sampleboolean

Returns last 10 appointments regardless of the other parameters. Used for testing purposes. true/false

sample_webhookboolean

Whether or not to parse the appointment in the same way the webhook parses it. Used for testing purposes. 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
      }
    ]
  }
]