Reservations: Supported Filters, Sorting, and Search

This article covers field support for filtering, sorting, and searching in the Reservations API.

Query Reservations

The following table shows field support for filters and sorting for the reservation object when using Query Reservations:

FieldSupported FiltersSortable
id$eq, $ne, $in
status$eq, $ne, $in
details.startDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable

Related content: API Query Language, Query Reservations

Search Reservations

The following table shows field support for filters and sorting for the reservation object when using Search Reservations:

FieldSupported FiltersSortable
source$eq, $ne, $in
status$eq, $ne, $in
details.reservationLocationId$eq, $ne, $in
reservee.contactId$eq, $ne, $in
details.tableIds$eq, $has_all, $has_some, $empty
details.startDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
details.partySize$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
createdDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable
updatedDate$eq, $ne, $lt, $lte, $gt, $gte, $inSortable

The following fields in the reservation object are searchable:

  • reservee.firstName
  • reservee.lastName
  • reservee.phone
  • reservee.email

Related content: Search Reservations

Was this helpful?
Yes
No