v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Client

Retrieve client's service histories

Get a list of client service histories for specified business id and client id

get/api/business/{businessId}/client/{clientId}/service-history

Path parameters

businessIdstring required
clientIdstring required

Query parameters

number of client service history records to return, max is 100

page number, default is 0 and is optional

Response

Client's service histories listed

Example response

{
  "_embedded": {
    "clientServiceHistories": [
      {
        "branchId": "branch123",
        "clientId": "client123",
        "notes": "Some notes",
        "systemNotes": "Some system notes",
        "date": "2016-04-06",
        "bookingId": "onlineBooking123",
        "services": [
          {
            "appointmentId": "appointmentId123",
            "staffId": "staff123",
            "serviceId": "service123",
            "clientCourseItemId": "course123",
            "groupBookingId": "groupBooking123",
            "serviceCategoryId": "serviceCategory123",
            "serviceGroupId": "serviceGroup123",
            "serviceGroupItemOptionId": "serviceGroupItemOption123",
            "serviceRewardId": "serviceReward123",
            "description": "Some description",
            "depositAmount": 12.12,
            "duration": 60,
            "discount": 12,
            "fee": 50,
            "originalPrice": 65,
            "checkedIn": true,
            "cancelled": true
          }
        ]
      }
    ]
  }
}