MYmytime
Client

Get client details

Changed on

Get client details

get/clients/{id}

Request

  • Base URL
    https://partners-api.mytime.com/api
  • Auth
    API key in header X-Api-Key

Path parameters

idstring required

Id

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
client_sincestring
client_date_of_birthstring
client_genderstring
uuid_1643976617226string
uuid_1643976736361string
uuid_1643976777371string
uuid_1643976834456string
uuid_1643976900041string
uuid_1643976927691string
uuid_1643977014685string
uuid_1643977092400string
uuid_1643977192813string
uuid_1643977351794string
uuid_1643977689302string
uuid_1643978212459string
uuid_1643978252522string
uuid_1643830793737string
uuid_1653495617880string
uuid_1653495665935string
uuid_1653495770418string
uuid_1653496014763string
uuid_1653496050157string
uuid_1653496075602string
uuid_1653496126053string
uuid_1653496151355string
uuid_1653570873238string
uuid_1653575282705string
uuid_1653575360018string
uuid_1711124828821string
uuid_1711125020620string
uuid_1729783923123string
client_sourcestring
client_utm_mediumstring
client_utm_campaignstring

Example response

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

Changes