Time Slot Object

A time slot represents a specific time period when a service is available for booking. It provides all the information needed to display availability to customers, including whether customers can actually book it, the remaining capacity, and which staff members or resources are available. Available time slots may not always be bookable due to service booking policies. When this occurs, the time slot includes information about the specific booking restrictions.

For multi-service bookings, the top-level time slot acts as a container spanning the entire service sequence (from the start of the first service to the end of the last service). Individual service details are provided in nested time slots.

Properties
serviceIdstringformat GUID

Service ID (SDK | REST).

Available only for single-service bookings. For multi-service bookings, this field is empty and individual service IDs are provided in nestedTimeSlots.

localStartDatestringformat LOCAL_DATE_TIME

Local start date of the time slot in YYYY-MM-DDThh:mm:ss ISO-8601 format. For example, 2026-01-30T13:30:00.

For multi-service bookings, this represents the start time of the first service in the sequence.

localEndDatestringformat LOCAL_DATE_TIME

Local end date of the time slot in YYYY-MM-DDThh:mm:ss ISO-8601 format. For example, 2026-01-30T14:00:00.

For multi-service bookings, this represents the end time of the last service in the sequence.

bookableboolean

Whether customers can book the slot according to the service's booking policies (SDK | REST).

For multi-service bookings, this is true only when all services in the sequence comply with their respective booking policies.

locationLocation

Information about where the business provides the service to the customer.

eventInfoEventInfo

Information about the event (SDK | REST) related to the slot. Available only for classes. Not available for appointment-based services and courses.

totalCapacityintegerminimum 1maximum 1000format int32

Total number of spots for the slot.

For multi-service bookings, this is always 1 because customers book the entire service sequence as a single unit.

remainingCapacityintegerminimum 0maximum 1000format int32

Remaining number of spots for the slot.

  • For appointment bookings: Either 1 (available) or 0 (unavailable).
  • For classes: Total capacity minus booked spots. Doesn't account for waitlist reservations. For classes with waitlists, use bookableCapacity to get the actual number of spots customers can book.
  • For courses: Total capacity minus booked spots. Courses don't currently support waitlists.
bookableCapacityintegerformat int32

Number of spots that customers can book for the slot. Calculated as the remaining capacity minus the spots reserved for the waitlist. If the service has no waitlist, identical to remainingCapacity.

For multi-service bookings, this is either 1 (sequence can be booked) or 0 (sequence can't be booked).

bookingPolicyViolationsBookingPolicyViolations

Information about booking policy violations for the slot.

For multi-service bookings, this aggregates violations from all services in the sequence.

availableResourcesArray <AvailableResources>minItems 0

List of resources (SDK | REST) available during the time slot.

Available only for single-service bookings. For multi-service bookings, resource information is provided in nestedTimeSlots.

nestedTimeSlotsArray <NestedTimeSlot>maxItems 8

Nested time slots for multi-service bookings. Each nested slot represents 1 service in the sequence, ordered according to the service sequence specified in the request.

Available only for multi-service bookings. Empty for single-service bookings.

nonBookableReasonsNonBookableReasons

Information about why customers can't book the time slot.

scheduleIdstringformat GUID

Schedule ID associated with this time slot. Same as the service's schedule ID.

Did this help?