queryReservations( )

Developer Preview

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

Creates a query to retrieve a list of reservations.

The queryReservations() function builds a query to retrieve a list of reservations and returns a ReservationsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() function.

You can refine the query by chaining ReservationsQueryBuilder functions onto the query. ReservationsQueryBuilder functions enable you to filter, sort, and control the results that queryReservations() returns.

queryReservations() runs with the following ReservationsQueryBuilder defaults, which you can override:

The following ReservationsQueryBuilder functions are supported for queryReservations(). For a full description of the reservation object, see the object returned for the items property in ReservationsQueryResult.

Admin Method

This function requires elevated permissions and runs only on the backend and on dashboard pages.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Reservations (Medium)
Manage Reservations (Full)
Learn more about permission scopes.
Method Declaration
This method does not take any parameters
Was this helpful?