Post

Query Extended Bookings

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, given the provided paging, filtering, and sorting.

Up to 100 bookings can be returned per request.

Query Extended Bookings 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 only specify a filter only once per query. If a filter is provided more than once, only the first occurrence affects the returned bookings.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Bookings - Including Participants
Read bookings calendar - including participants
Manage Bookings
Learn more about permission scopes.
Endpoint
POST
https://www.wixapis.com/bookings/bookings-reader/v2/extended-bookings/query
Was this helpful?
Yes
No