POST

Query Reservations

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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 a list of reservations given the provided paging, filtering, and sorting. Up to 100 reservations can be returned per request.

For a detailed list of supported operations, see the Sorting, Filtering, and Search article. To learn how to query reservations, see API Query Language.

PropertyFiltersSort
_id$eq, $ne, $inNone
status$eq, $ne, $inNone
details.startDate$eq, $ne, $in, $lt, $gt, $lte, $gteSort: ASC, DESC
Authentication

This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:

Permissions
Manage Reservations (Medium)
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?