Clients API

API Authentication

See API Authentication article for details

Search by Phone

Request

https://{host}/api/v1/clients?phone={phone}&companyId={companyId}

phone: String (required) - an 11 digit phone number. For example 18009998765

companyId: Number (required) - the internal id of a Zr Ware™ company

Response

{
  "clients": {
    "count": 1,
    "data": [
      {
        "clientId": 368135,
        "upcomingBookings": {
          "count": 1,
            "data": [
              {
                "bookingId": 3936678
              }
            ]
        }
      }
    ]
}

Note: Additional work will be performed to standardize error responses from the server.