POST

Query Booking Policies


Retrieves a list of booking policies, given the provided paging, filtering, and sorting.

Query Booking Policies runs with these defaults, which you can override:

  • Sorted by createdDate in ascending order.
  • cursorPaging.limit set to 100.

For details about all supported filters and sorting options, see supported filters.

To learn about working with Query endpoints, see API Query Language, Sorting and Paging, and Field Projection.

FieldSupported FiltersSort
id$eq, $in, $neSort: ASC, DESC
name$eq, $ne, $beginsSort: ASC, DESC
customPolicyDescription.description$eq, $ne, $beginsSort: ASC, DESC
intakeFormPolicy.formId$eq, $ne, $beginsSort: ASC, DESC
default$eq, $neSort: ASC, DESC
customPolicyDescription.enabled$eq, $neSort: ASC, DESC
limitEarlyBookingPolicy.enabled$eq, $neSort: ASC, DESC
limitLateBookingPolicy.enabled$eq, $neSort: ASC, DESC
bookAfterStartPolicy.enabled$eq, $neSort: ASC, DESC
cancellationPolicy.enabled$eq, $neSort: ASC, DESC
cancellationPolicy.limitLatestCancellation$eq, $neSort: ASC, DESC
reschedulePolicy.enabled$eq, $neSort: ASC, DESC
reschedulePolicy.limitLatestReschedule$eq, $neSort: ASC, DESC
waitlistPolicy.enabled$eq, $neSort: ASC, DESC
resourcesPolicy.enabled$eq, $neSort: ASC, DESC
resourcesPolicy.autoAssignAllowed$eq, $neSort: ASC, DESC
limitEarlyBookingPolicy.earliestBookingInMinutes$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
limitLateBookingPolicy.latestBookingInMinutes$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
cancellationPolicy.latestCancellationInMinutes$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
reschedulePolicy.latestRescheduleInMinutes$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
waitlistPolicy.capacity$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
waitlistPolicy.reservationTimeInMinutes$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
participantsPolicy.maxParticipantsPerBooking$eq, $ne, $in, $nin, $lt, $lte, $gt, $gteSort: ASC, DESC
Permissions
Read Bookings - Public Data
Learn more about app permissions.
Endpoint
POST
https://www.wixapis.com/bookings/v1/booking-policies/query

Errors

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

Did this help?