queryExtendedBookings( )

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 bookings, including additional extended information, given the provided paging, filtering, and sorting.

Up to 100 extended bookings can be returned per request.

queryExtendedBookings() runs with these defaults, which you can override:

  • createdDate sorted in DESC order
  • cursorPaging.limit is 50

You can retrieve information about which actions the customer can perform for the bookings. To do so, pass withBookingAllowedActions as true.

For field support, see supported filters for more information.

You can specify a filter only once per query. If you specify a filter more than once, only the first filter determines the extended bookings that are returned.

When filtering by date, you must use UTC time.

Note: This function is restricted and only runs if you elevate permissions using the wix-auth.elevate() function.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Bookings
Read Bookings - Including Participants
Read Bookings - all read permissions
Manage Bookings - all permissions
Read bookings calendar - including participants
Learn more about permission scopes.
Method Declaration
Copy
Method Parameters
queryCommonQueryV2Required

Information about filters, paging, and sorting.

optionsQueryExtendedBookingsOptions

Additional options for performing the query.

Returns
Return Type:Promise<QueryExtendedBookingsResponse>
Was this helpful?
Yes
No