getAvailabilityTimeSlot( )

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 detailed information about a specific appointment time slot.

Call this method to get complete resource availability after finding a suitable slot with List Availability Time Slots (SDK | REST).

Defaults

Get Availability Time Slot uses the following defaults:

  • Returns all available resources unless filtered by resourceIds or includeResourceTypeIds.
  • Includes full booking status and capacity details

Service type limitations

Only appointment-based services are supported when calling Get Availability Time Slot.

To retrieve class session availability, you can call Get Event Time Slot (SDK | REST).

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

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 instead for availability calculation.

Permissions
Read Bookings Calendar Availability
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
serviceIdstringRequired

Service ID of the time slot. You must specify the ID of an appointment-based service.

localStartDatestringRequired

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

localEndDatestringRequired

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

timeZonestringRequired

Time zone in IANA tz database format for adjusting fromLocalDate and toLocalDate. For example, America/New_York or UTC.

Default: timeZone specified in the business site properties (SDK | REST).

locationLocationRequired

Location to filter time slots by.

For business locations, you must specify a location ID. When specifying a location ID, all other location field filters are ignored.

optionsGetAvailabilityTimeSlotOptions
Returns
Return Type:Promise<GetAvailabilityTimeSlotResponse>
Errors
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?