v3
latestOpenAPI 3.0.02026-07-3179137151.7 KBBookings
Query for a pageable list of bookings.
Either property_ids or since_utc is required.
get/v2/bookings
Query parameters
property_idsinteger[] nullable
Filter bookings to only these properties. (Comma separated integers)
fromstring date-time nullable
Filter for bookings that depart on or after a specific date (in property timezone).
tostring date-time nullable
Filter for bookings that arrive on or before a specific date (in property timezone).
since_utcstring date-time nullable
Filter for bookings created or changed since a specific date (UTC).
status'active' | 'canceled' | 'pending'
Filter bookings by status: Active, Pending, Canceled.
include_door_codesboolean
Include door codes collection on results.
include_chargesboolean
Include charges collection on results.
include_tagsboolean
Include tags collection on results.
include_fieldsboolean
Include fields collection on results.
include_guestboolean
Include guest names on results.
include_cancellation_policyboolean
Include cancellation policy description on results.
include_agreementsboolean
Include booking agreements on results.
Response
A pageable list of BookingModels representing the matching Bookings.