Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Appointment Availability

List appointment availabilities

Get a list of available appointment times for the specified business id and branch id, within the specified date range for the specified services

post/api/business/{businessId}/branch/{branchId}/appointments/availability

Path parameters

businessIdstring required
branchIdstring required

Request body

clientIdstring

The unique client identifier

startTimestring date-time required

The earliest time to consider an available appointment in ISO 8601 format

endTimestring date-time required

The latest time to consider an available appointment in ISO 8601 format

rescheduleBookingIdstring

The id of an existing appointment, if the request is being made to find availability in order to reschedule that existing appointment

isOnlineAvailabilityboolean

Fetch staff available online

Example request

{
  "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
  "clientServiceSelections": [
    {
      "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
      "serviceSelections": [
        {
          "serviceId": "C-FYeVKIwfwL3av2WYcYjA",
          "branchServiceGroupId": "b6xtq-4iX7LJ2_cPQQYDTQ",
          "staffId": "G4iZa1VHaKCPcyv6Lt3BoA"
        }
      ]
    }
  ],
  "rescheduleBookingId": "b6xtq-4iX7LJ2_cPQQYDTQ",
  "isOnlineAvailability": true
}

Response

Appointment availabilities listed

Example response

{
  "data": [
    {
      "clientSchedules": [
        {
          "clientId": "dbNZRQHDqAn6VlVoL2c-iA",
          "serviceSchedules": [
            {
              "serviceId": "C-FYeVKIwfwL3av2WYcYjA",
              "appointmentId": "TZcha-e8oanJ2KXwSIYkuA",
              "staffId": "G4iZa1VHaKCPcyv6Lt3BoA",
              "roomId": "G4iZa1VHaKCPcyv6Lt3BoA",
              "machineId": "cFoBTXLnUrYNf1uM8HfDcR",
              "branchServiceGroupId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI",
              "serviceGroupItemOptionId": "VsB-vaCGhhnKuOSONFWcHgH1UNXM21Qvb_bJPOAI5QI"
            }
          ]
        }
      ]
    }
  ]
}