Sign in

v1

latestSwagger 2.02026-08-06115129197.7 KB
Client

Returns all clients from the system that the user has access to.

    For each user - identified by user and password - we should have only one client per company.
    Different MyTime Companies will have different client records for each user.
get/clients

Query parameters

pagestring

Pagination - results page number

per_pagestring

Pagination - number of results per per_page. Default: 20. Maximum: 20

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

include_labelsboolean

Include the labels for the client. true/false

include_memberships_labelsboolean

Include the memberships labels for the client. true/false

include_membershipsboolean

Include the memberships for the client. true/false

appointment_countboolean

Include the appointments count. true/false

location_partner_idsstring[]

Filter clients by location

location_mytime_idsinteger[]

Filter clients by location using mytime ids

searchstring

Filter clients by search term

client_typestring

Filter by client type. Allowed values: Client or Lead. Default: Client. Unsupported values default to Client.

sample_webhookboolean

Whether or not to parse the client in the same way the webhook parses it. Used for testing purposes. true/false

Headers

X-Subdomainstring

Merchant subdomain - Optional

Response

Clients response

countinteger

Example response

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