POST

List Availability Time Slots


Developer Preview

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 appointment time slots that match the provided filters.

Defaults

List Availability Time Slots uses the following defaults:

  • Sorts time slots by localStartDate in ascending order.
  • cursorPaging.limit set to 1000.
  • Returns both bookable and un-bookable time slots.
  • If bookable filter isn't specified, bookable slots are returned first.
  • fromLocalDate is set to the current time.

Filtering behavior

The method automatically filters time slots:

  • Past time slots: Only time slots starting from the specified fromLocalDate are included. When you omit fromLocalDate, Wix Bookings uses the current time as the default.
  • Resource availability: Only time slots with at least some available resources are returned.

Service type limitations

Only appointment-based services are supported when calling List Availability Time Slots.

To retrieve class availability, you can call List Event Time Slots(SDK | REST).

To retrieve course availability, you can follow the End-to-End Booking Flow for course(SDK | REST).

Booking policy filtering

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.

  • Set 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.
  • Set tooLateToBook to true to retrieve slots that can no longer be booked due to maximum advance booking time restrictions.
  • Set bookOnlineDisabled to true or false to filter by online booking availability settings.

Available resources

Time slots aren't returned when they have no available resources.

Each time slot includes details for up to 10 available resources. If there are more than 10 resources, you can call Get Availability Time Slots (SDK | REST) and filter by the resource Type ID to get details for the remaining resources.

Business hours exception

Wix Bookings disregards business opening hours when all of the following conditions are met:

  1. 1 or more staff members (SDK | REST) are needed to provide the service.
  2. No other resource type (SDK | REST) is needed to provide the service.
  3. The service doesn't have duration-based variants (SDK | REST).

In these cases, the working hours of the relevant staff member are used for availability calculation.

Endpoint
POST
https://www.wixapis.com/_api/service-availability/v2/time-slots

Errors
400Invalid Argument

There is 1 error with this status code.

403Permission Denied

There is 1 error with this status code.

404Not Found

There are 3 errors with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?