This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.
Retrieves a list of class session time slots that match the provided filters.
List Event Time Slots uses the following defaults:
providerId
set to the Bookings app ID.timeZone
set to the business time zone.cursorPaging.limit
set to 50
.Time slots are always sorted by their localStartDate
in ascending order.
To retrieve appointment availability, call List Availability Time Slots (SDK | REST).
To retrieve course availability, follow the End-to-End Booking Flow for courses (SDK | REST).
Use bookingPolicyViolations
to filter slots based on booking restrictions defined in your booking policies (SDK | REST).
Default behavior*: When you don't specify any bookingPolicyViolations
filters, all slots are returned regardless of their booking policy status.
tooEarlyToBook
to true
to retrieve slots that can't be booked yet due to minimum advance booking time restrictions.
Currently, you can't specify earliestBookingDate
to further filter by when the slot becomes bookable.tooLateToBook
to true
to retrieve slots that can no longer be booked due to maximum advance booking time restrictions.bookOnlineDisabled
to true
or false
to filter by online booking availability settings.This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.