v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB

Appointment

List appointments

Get a list of appointments for the specified business id and branch id, with a maximum one month date range. List can be filtered by date of appointment, DateTime of update, staff id, room id, machine id or client id with possibility to include canceled, deleted or archived appointments and option to fetch online categories and notes of appointments. Results can be sorted using the standard 'sort' parameter in 'property,direction' form (e.g. 'sort=appointmentDate,desc'); when omitted, results are returned in the default order - by creation date, or by update time for updated-range queries.

get/api/business/{businessId}/branch/{branchId}/appointment

Path parameters

businessIdstring required

branchIdstring required

Query parameters

from_datestring date

from date to query from. yyyy-MM-dd

to_datestring date

to date (inclusive) to query to. yyyy-MM-dd

staff_idstring

staff id to filter by

room_idstring

room id to filter by

machine_idstring

machine id to filter by

client_idstring

client id to filter by

fetch_canceledboolean

include canceled appointments in the list

fetch_deletedboolean

include deleted appointments in the list

fetch_archivedboolean

include archived appointments in the list

updated_fromstring

date-time from which the appointments has been updated onwards

updated_tostring

date-time to which the appointments has been updated backwards

fetch_online_categoryboolean

include online categories of appointments

fetch_notesboolean

include notes of appointments

group_booking_idstring

group booking id to filter by

number of appointments to return, max is 100

page number, default is 0 and is optional

sort results in 'property,direction' form. Supported properties are 'appointmentDate' and 'creationDate'; direction is 'asc' or 'desc' (defaults to 'asc'). Example: 'appointmentDate,desc'. When omitted, results are returned in the default order (by creation date, or by update time for updated-range queries)

Response

Appointments listed

Example response

{
  "_embedded": {
    "appointments": [
      {
        "appointmentId": "ab123",
        "version": 1,
        "appointmentDate": "2018-01-01",
        "startTime": "09:00:00",
        "endTime": "09:30:00",
        "price": 40,
        "staffId": "staffid",
        "roomId": "roomid",
        "machineId": "machineid",
        "confirmed": true,
        "serviceId": "serviceid",
        "staffRequest": true,
        "preferredStaff": true,
        "clientId": "clientid",
        "serviceRewardId": "servicerewardid",
        "courseId": "courseId",
        "courseName": "courseName",
        "clientCourseId": "clientCourseId",
        "clientCourseItemId": "clientcourseitemid",
        "purchasingBranchId": "purchasingBranchId",
        "serviceGroupItemOptionId": "servicegroupitemoptionid",
        "serviceGroupId": "servicegroupid",
        "parentServiceGroupId": "parentservicegroupid",
        "serviceName": "serviceName",
        "state": "BOOKED",
        "activationState": "ACTIVE",
        "depositAmount": 20,
        "bookingId": "bookingid",
        "source": "source",
        "groupBookingId": "groupbookingid",
        "deleted": true,
        "notes": "This is a note about the appointment",
        "internetServiceCategories": [
          {
            "id": "ab123",
            "name": "Cut & Style"
          }
        ],
        "branchId": "X9QpRsZ3bSvhJAaakg9TXQ"
      }
    ]
  }
}