queryBookingPolicies( )


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 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 the supported filters article.

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

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),in(),ne(),ascending(),descending()
nameeq(),ne(),startsWith(),ascending(),descending()
customPolicyDescription.enabledeq(),ne(),ascending(),descending()
customPolicyDescription.descriptioneq(),ne(),startsWith(),ascending(),descending()
defaulteq(),ne(),ascending(),descending()
limitEarlyBookingPolicy.enabledeq(),ne(),ascending(),descending()
limitEarlyBookingPolicy.earliestBookingInMinuteseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
limitLateBookingPolicy.enabledeq(),ne(),ascending(),descending()
limitLateBookingPolicy.latestBookingInMinuteseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
bookAfterStartPolicy.enabledeq(),ne(),ascending(),descending()
cancellationPolicy.enabledeq(),ne(),ascending(),descending()
cancellationPolicy.limitLatestCancellationeq(),ne(),ascending(),descending()
cancellationPolicy.latestCancellationInMinuteseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
reschedulePolicy.enabledeq(),ne(),ascending(),descending()
reschedulePolicy.limitLatestRescheduleeq(),ne(),ascending(),descending()
reschedulePolicy.latestRescheduleInMinuteseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
waitlistPolicy.enabledeq(),ne(),ascending(),descending()
waitlistPolicy.capacityeq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
waitlistPolicy.reservationTimeInMinuteseq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
participantsPolicy.maxParticipantsPerBookingeq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending()
resourcesPolicy.enabledeq(),ne(),ascending(),descending()
resourcesPolicy.autoAssignAllowedeq(),ne(),ascending(),descending()
Permissions
Manage Bookings Services and Settings
Manage Bookings - all permissions
Read Bookings - all read permissions
Manage Bookings
Read Bookings - Public Data
Read Bookings - Including Participants
Learn more about app permissions.
Method Declaration
Copy
Request
This method does not take any parameters
Returns
Was this helpful?
Yes
No