getMultiServiceBooking( )

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 booking and all its associated single-service bookings.

Returns the complete multi-service booking information including its ID, associated single-service bookings, and the total number of scheduled single-service bookings.

If you call on behalf of an identity with permissions to read only part of the multi-service booking, only the permitted single-service bookings are retrieved. The returned total number includes single-service bookings for which you don't have permissions.

See Query Extended Bookings (SDK | REST) for details about retrieving individual single-service bookings and additional metadata.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Read Bookings Calendar Availability
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
multiServiceBookingIdstringRequired

ID of the multi-service booking.

Returns
Return Type:Promise<MultiServiceBooking>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?