POST

Query Extended Bookings

Note: This query method uses the new Wix API Query Language syntax. If you're still using the old query syntax with chained query builder methods, see Migrate from SDK Query Builders to Wix API Query Language for guidance. The old query builder methods continue to work.

Retrieves up to 100 bookings, given the specified paging, filtering, and sorting.

Query Extended Bookings runs with these defaults, which you can override:

  • id sorted in ASC order
  • cursorPaging.limit is 50

To retrieve course bookings, filter by scheduleId of the relevant service.

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

When using filters for dates, you must use UTC time.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

Permissions
Read bookings calendar - including participants
Manage Bookings
Read Bookings - Including Participants
Learn more about app permissions.
Method Declaration
Copy
Errors

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

Did this help?