getMultiServiceAvailabilityTimeSlot( )


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 multi-service time slot that matches the specified filters.

Call this method after finding a suitable slot with List Multi-Service Availability Time Slots to obtain full capacity, resource, and booking-policy details.

The returned time slot acts as a container spanning the entire service sequence, with nested time slots providing detailed information for each individual service.

Defaults

  • Returns all available resources unless you filter by services.resourceIds or services.includeResourceTypeIds.
  • Includes full booking-status and capacity details.

Service type limitations

Only appointment-type services are supported.

To retrieve appointment availability for a single service, call List Availability Time Slots (SDK | REST).

Method Declaration
Copy
Method Parameters
servicesArray<Service>Required

Services for which the multi-service time slots are returned. You can specify resource filters for each 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 values. For example, America/New_York or UTC.

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


locationLocationRequired

Location for which the multi-service time slots are returned. If you filter by {"type": "BUSINESS"}, you must also specify a location ID. A filter for location.name is ignored.

Required unless you specify cursorPaging.cursor.

Returns
Return Type:Promise<GetMultiServiceAvailabilityTimeSlotResponse>
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?