GET

List 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.

Retrieves a list of up to 100 reservations.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Reservations (Full)
Manage Reservations (Medium)
Manage Restaurants - all permissions
Learn more about app permissions.
Endpoint
GET
https://www.wixapis.com/table-reservations/reservations/v1/reservations

Query Params
paging.limitintegerminimum 0maximum 100format int32

Number of items to load.


paging.cursorstring

Pointer to the next or previous page in the list of results.

You can get the relevant cursor token from the pagingMetadata object in the previous call's response. Not relevant for the first request.


sort.fieldNamestring

Name of the field to sort by.


sort.orderstring

Sort order. Default: ASC.


startDateFromstring

Only reservations starting after this date are returned.


startDateTostring

Only reservations starting before this date are returned.


statusstring

Only reservations with this status are returned.

Response Object
reservationsArray <Reservation>

List of reservations.


pagingMetadataPagingMetadata

Metadata for the paginated results.

List reservations
Request
cURL
Response
JSON
Errors

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

Did this help?