このAPIは変更される可能性があります。プレビュー期間中、開発者からのフィードバックに基づいてバグ修正や新機能がリリースされる予定です。
Deprecation Notice:
This endpoint has been replaced with Bookings V2 Query Extended Bookings and will be removed on December 31, 2024.
Retrieves a list of bookings according to the provided filters and paging. The query runs with the following defaults:
1
You can override these defaults, and define other filters and paging, as shown in the following table.
Query object support:
Field | Supported Filters | Sortable |
---|---|---|
bookingId | $eq | |
contactId | $eq | |
sessionId | $eq , $in , $hasSome | |
scheduleId | $eq , $in , $hasSome | |
startTime | $gte , $lt | |
endTime | $gt , $lte | |
status | $eq , $in , $hasSome | |
createdDate | $gte , $lt | Sortable |
paging | Supported | |
fieldsets | Not supported. | |
fields | Not supported. |
注釈
クエリー
parameter are not supported for this query:
fields
fieldsets
withBookingAllowedActions
field.businessLocation.businessSchedule
object in the bookedEntity.location
object is not supported.
Permissions
This endpoint requires the Read Bookings - Including Participants permission scope.