v1

latestSwagger 2.02026-08-06115129197.7 KB

Client

Get client details

get/clients/{id}

Path parameters

idstring required

Query parameters

id_is_partnerboolean required

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

include_childrenboolean

Include the children for the client. true/false

include_appointmentsboolean

Include appointments for the client. true/false. Max: 50

include_appointment_eventsboolean

Include the events of the appointments for the client (dependent on "include_appointments"). true/false

appointment_countboolean

Include the appointments count. true/false

include_labelsboolean

Include the labels for the client. true/false

include_membershipsboolean

Include the memberships for the client. true/false

include_memberships_labelsboolean

Include the memberships labels for the client. true/false

Headers

X-Subdomainstring

Merchant subdomain - Optional

Response

Updated

first_namestring

last_namestring

mobile_phonestring

work_phonestring

home_phonestring

emailstring

contact_preferencestring

updated_atstring

created_atstring

appointment_countinteger

can_book_onlinestring

company_idstring

source_quick_addstring

has_missing_required_valuesstring

can_receive_automated_emailsboolean

can_receive_automated_smsboolean

can_receive_manual_emailsboolean

can_receive_manual_smsboolean

can_receive_manual_sms_confirmed_atboolean

can_receive_automated_sms_confirmed_atboolean

has_card_on_fileboolean

is_existing_customerboolean

associated_location_partner_idsstring[]

associated_location_mytime_idsstring[]

preferred_location_partner_idinteger

preferred_location_mytime_idinteger

partner_idinteger required

Example response

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