searchReservations( )


Developer Preview

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

Use this endpoint to search the fields of the table reservations on a site for a given expression.

You can also use this endpoint to perform data aggregations on a site's table reservation fields. For a detailed list of supported operations, see the Sorting, Filtering, and Search article.

Authentication

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

Permissions
Manage Reservations (Medium)
Manage Reservations (Full)
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
searchCursorSearchRequired

Search query.

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