Skip to main content
GET
Search Bookings
A booking is a reservation of a resource, such as a meeting room or desk, for a customer at a specified time; it can be tentative, recurring, charged, and invoiced.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Booking-List role.

Enums

Query Parameters

Pagination & Sorting

integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g. Name, CreatedOn).
integer
Sort direction. 0 for ascending, 1 for descending.

Filters

integer
Filter by iD of the resource being reserved; it determines the booking location and availability rules..
string
Filter by display value for Resource.Name..
integer
Filter by display value for Resource.Allocation..
boolean
Filter by display value for Resource.HideInCalendar..
integer
Filter by display value for Resource.NoReturnPolicy..
integer
Filter by display value for Resource.NoReturnPolicyAllResources..
integer
Filter by display value for Resource.NoReturnPolicyAllUsers..
integer
Filter by display value for Resource.ResourceType.Id..
string
Filter by display value for Resource.ResourceType.Name..
integer
Filter by optional ID of the floor-plan unit assigned within the selected resource. The unit must be connected to this resource.
string
Filter by display value for FloorPlanDesk.Name..
integer
Filter by optional ID of the customer this booking is for..
string
Filter by display value for Coworker.CoworkerType..
string
Filter by display value for Coworker.FullName..
string
Filter by display value for Coworker.MobilePhone..
string
Filter by display value for Coworker.LandLine..
string
Filter by display value for Coworker.BillingName..
string
Filter by display value for Coworker.CompanyName..
string
Filter by display value for Coworker.TeamNames..
integer
Filter by optional ID of the rate used to price this booking. Set it only to a rate linked to the selected resource’s ResourceType. When no rate is provided, the system calculates an applicable rate automatically..
string
Filter by display value for ExtraService.Name..
string
Filter by booking start date and time in UTC..
string
Filter by booking end date and time in UTC; it must be after FromTime..
string
Filter by customer-facing notes for the booking..
string
Filter by internal staff notes recorded when the booking is created..
boolean
Filter by whether to charge the booking immediately when it is created or updated..
boolean
Filter by whether to generate an invoice for the booking immediately..
boolean
Filter by whether the selected customer receives the booking charge. When false, the customer’s team-paying member, if any, is the billing party..
boolean
Filter by whether to prevent available customer booking credit from being used for this booking..
string
Filter by optional customer purchase-order reference for the booking..
string
Filter by optional discount code applied when the booking price is calculated..
string
Filter by system-maintained UTC timestamp of the last booking notification..
string
Filter by internal Google Calendar identifier maintained by calendar synchronization..
string
Filter by internal Google Calendar event identifier maintained by calendar synchronization..
string
Filter by internal Microsoft 365 calendar event identifier maintained by synchronization..
string
Filter by internal public Google Calendar event identifier maintained by synchronization..
boolean
Filter by whether the booking is tentative and still requires confirmation. Customer bookings for resources requiring confirmation are created as tentative; administrators can create tentative bookings for any resource..
boolean
Filter by whether this is an online booking, as determined by the selected resource..
string
Filter by system snapshot of the customer’s team memberships when the booking was made..
string
Filter by system snapshot of the customer’s plan when the booking was made..
string
Filter by system-generated identifier linking all bookings in the same recurrence series; use it to find and update all bookings in that series..
boolean
Filter by whether to create a recurring series from this booking..
integer
Filter by recurrence cycle: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth..
integer
Filter by for a recurring booking update, selects whether to update this booking, future bookings, all bookings, not-charged bookings, or perform the corresponding delete or charge-reversal action..
integer
Filter by optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks..
string
Filter by optional final UTC date and time for creating occurrences in the recurrence series..
boolean
Filter by whether a weekly recurring booking includes Mondays..
boolean
Filter by whether a weekly recurring booking includes Tuesdays..
boolean
Filter by whether a weekly recurring booking includes Wednesdays..
boolean
Filter by whether a weekly recurring booking includes Thursdays..
boolean
Filter by whether a weekly recurring booking includes Fridays..
boolean
Filter by whether a weekly recurring booking includes Saturdays..
boolean
Filter by whether a weekly recurring booking includes Sundays..
boolean
Filter by system flag showing whether the standard booking reminder has been sent..
boolean
Filter by system flag showing whether the standard booking notification has been sent..
boolean
Filter by system flag showing whether an MRM reminder has been sent..
number
Filter by optional total price override for this booking, before normal rate calculation..
boolean
Filter by whether the booking price has been calculated and posted to the customer’s account as a CoworkerExtraService and, when applicable, CoworkerProducts. This does not indicate whether the booking has been invoiced..
string
Filter by uTC date and time when the booking was charged..
integer
Filter by system-generated booking reference number..
integer
Filter by internal Kisi access-control key identifier for this booking..
string
Filter by internal scheduled-job identifier for the booking start..
string
Filter by internal scheduled-job identifier for the booking end..
boolean
Filter by internal billing-processing state for this booking..
string
Filter by system-maintained local-time representation of FromTime..
string
Filter by system-maintained local-time representation of ToTime..
string
Filter by system-maintained local-time representation of InvoiceDate..
integer
Filter by system-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity..
string
Filter by system-maintained invoice number associated with this booking, populated when the booking is included in an invoice..
boolean
Filter by read-only indicator that the associated invoice has been paid, populated when the booking is included in an invoice..
boolean
Filter by read-only indicator that the associated invoice is still a draft, populated when the booking is included in an invoice..
boolean
Filter by read-only indicator that the associated invoice has been voided, populated when the booking is included in an invoice..
boolean
Filter by read-only indicator that the associated invoice is a credit note, populated when the booking is included in an invoice..
string
Filter by system-maintained serialized identifiers of customer rate entitlements used by this booking..
number
Filter by system-calculated price from the customer’s applicable rate entitlement..
string
Filter by system-calculated currency code for the customer rate entitlement used by this booking..
integer
Filter by system-calculated charge-period setting for the customer rate entitlement used by this booking..
integer
Filter by system-calculated number of customer rate uses consumed or available for this booking..
boolean
Filter by whether to include a Zoom meeting invitation for this booking..
string
Filter by internal Zoom event payload maintained by the integration..
string
Filter by uTC date and time when the booking was checked in through the booking workflow..
boolean
Filter by system-derived resource policy that cancels this booking when payment is not received..
boolean
Filter by system-derived resource policy that cancels this booking when no check-in occurs..
integer
Filter by maximum occupancy detected by sensors in the selected resource during this booking..
number
Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking..
number
Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location..
number
Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment..
number
Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing..
string
Filter by internal Microsoft 365 administrator calendar event identifier maintained by synchronization..
string
Filter by uTC date and time when the customer checked in for this booking..
string
Filter by uTC date and time when the customer checked out from this booking..

Range Filters

integer
Filter by display value for Resource.Allocation. greater than or equal to this value.
integer
Filter by display value for Resource.Allocation. less than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicy. greater than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicy. less than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllResources. greater than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllResources. less than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllUsers. greater than or equal to this value.
integer
Filter by display value for Resource.NoReturnPolicyAllUsers. less than or equal to this value.
integer
Filter by display value for Resource.ResourceType.Id. greater than or equal to this value.
integer
Filter by display value for Resource.ResourceType.Id. less than or equal to this value.
string
Filter by booking start date and time in UTC. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by booking start date and time in UTC. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by booking end date and time in UTC; it must be after FromTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by booking end date and time in UTC; it must be after FromTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained UTC timestamp of the last booking notification. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained UTC timestamp of the last booking notification. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks. greater than or equal to this value.
integer
Filter by optional positive recurrence interval; for example, 2 with Weekly repeats every two weeks. less than or equal to this value.
string
Filter by optional final UTC date and time for creating occurrences in the recurrence series. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by optional final UTC date and time for creating occurrences in the recurrence series. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
number
Filter by optional total price override for this booking, before normal rate calculation. greater than or equal to this value.
number
Filter by optional total price override for this booking, before normal rate calculation. less than or equal to this value.
string
Filter by uTC date and time when the booking was charged. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the booking was charged. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by system-generated booking reference number. greater than or equal to this value.
integer
Filter by system-generated booking reference number. less than or equal to this value.
integer
Filter by internal Kisi access-control key identifier for this booking. greater than or equal to this value.
integer
Filter by internal Kisi access-control key identifier for this booking. less than or equal to this value.
string
Filter by system-maintained local-time representation of FromTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of FromTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of ToTime. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of ToTime. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of InvoiceDate. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by system-maintained local-time representation of InvoiceDate. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by system-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity. greater than or equal to this value.
integer
Filter by system-maintained ID of the invoice associated with this booking; manage invoices through the invoice entity. less than or equal to this value.
number
Filter by system-calculated price from the customer’s applicable rate entitlement. greater than or equal to this value.
number
Filter by system-calculated price from the customer’s applicable rate entitlement. less than or equal to this value.
integer
Filter by system-calculated charge-period setting for the customer rate entitlement used by this booking. greater than or equal to this value.
integer
Filter by system-calculated charge-period setting for the customer rate entitlement used by this booking. less than or equal to this value.
integer
Filter by system-calculated number of customer rate uses consumed or available for this booking. greater than or equal to this value.
integer
Filter by system-calculated number of customer rate uses consumed or available for this booking. less than or equal to this value.
string
Filter by uTC date and time when the booking was checked in through the booking workflow. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the booking was checked in through the booking workflow. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
integer
Filter by maximum occupancy detected by sensors in the selected resource during this booking. greater than or equal to this value.
integer
Filter by maximum occupancy detected by sensors in the selected resource during this booking. less than or equal to this value.
number
Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking. greater than or equal to this value.
number
Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location, applied for a last-minute booking. less than or equal to this value.
number
Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location. greater than or equal to this value.
number
Filter by system-calculated monetary adjustment from the dynamic-pricing settings for the selected resource or location. less than or equal to this value.
number
Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment. greater than or equal to this value.
number
Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for the last-minute price adjustment. less than or equal to this value.
number
Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing. greater than or equal to this value.
number
Filter by system-calculated multiplier from the dynamic-pricing settings for the selected resource or location, used for demand-based dynamic pricing. less than or equal to this value.
string
Filter by uTC date and time when the customer checked in for this booking. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the customer checked in for this booking. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the customer checked out from this booking. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter by uTC date and time when the customer checked out from this booking. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

Booking[]
The list of Booking records matching the query. See the Get one Booking endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each Booking. The following fields are not populated in the Records[] response: InternalNotes, ChargeNow, InvoiceNow, InvoiceThisCoworker, DoNotUseBookingCredit, RepeatBooking, Repeats, WhichBookingsToUpdate, RepeatEvery, RepeatUntil, RepeatOnMondays, RepeatOnTuesdays, RepeatOnWednesdays, RepeatOnThursdays, RepeatOnFridays, RepeatOnSaturdays, RepeatOnSundays, OverridePrice, IncludeZoomInvite.To get all fields, fetch the full record using the Get one Booking endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (0 = ascending, 1 = descending).
integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response