Params

NameTypeRequirenessDefault valueDescription
booking_uidsstringoptionalnoneList of comma separated booking UIDs
booking_statusstringoptionalnoneOne of available booking statuses (see the corresponding filters section)
platform_typestringoptionalnoneList of comma separated platform types (see the corresponding filters section). This filter returns bookings related to one of mentioned platform types
from_datestringoptionalnoneHide bookings ended before this date
to_datestringoptionalnoneHide bookings which will be started after this date
from_created_datestringoptionalnoneHide bookings which created on iGMS before this date
to_created_datestringoptionalnoneHide bookings which created on iGMS after this date
from_updated_datestringoptionalnoneHide bookings which updated before this date
to_updated_datestringoptionalnoneHide bookings which updated after this date
from_booked_datestringoptionalnoneHide bookings which are booked before this date
to_booked_datestringoptionalnoneHide bookings which are booked after this date
order_by_created_dttmbooloptionalnoneWhen true, results are ordered by created_dttm DESC (newest first)
pageintoptional1Page number for pagination

Description

List of active bookings

This endpoint requires one of the following scopes: messaging, smart-locks, external-cleaning-management

Response sample

{
    "data": [
        {
            "booking_uid": "AXFNTT_airbnb_123",
            "reservation_code": "AXFNTT",
            "readable_reservation_code": "AXFNTT",
            "booking_status": "accepted",
            "reservation_type": "regular",
            "platform_type": "airbnb",
            "listing_uid": "1_airbnb_123",
            "property_uid": "1482329366187",
            "guest_uid": "456_airbnb",
            "host_uid": "123_airbnb",
            "local_checkin_dttm": "2019-01-05 08:30:00",
            "local_checkout_dttm": "2019-01-12 03:00:00",
            "created_dttm": "2019-01-05 08:30:00",
            "updated_dttm": "2019-01-05 08:30:00",
            "booked_dttm": "2019-01-05 08:29:33",
            "number_of_guests": 2,
            "guests_breakdown": {
                "adults": 2,
                "children": 1,
                "pets": 0
            },
            "price": {
                "currency": "USD",
                "price_base": 100.00,                           
                "price_extras": 10.00,                            
                "price_fee": 16.00,                                                                       
                "price_tax": 10.00,                            
                "price_total": 94.00                            
            },
            "comments": null,
            "special_requests": null,
            "door_access_code": null
        }
    ],
    "meta": {
        "page": 1,
        "has_next_page": true
    }
}

reservation_type is regular for a booking, or owner_block for an Owner's Block — dates the property owner has reserved for their own use. An Owner's Block is not a stay: it has no guest and no money, so every price field is 0 and guest_uid resolves to the account that created it.

price_fee is the channel's host fee. On most platforms the channel withholds it, so price_total is the host payout net of price_fee. Vrbo and in some cases Booking.com invoice their host fee to the host after the stay instead of withholding it, so on those bookings price_total is not net of price_fee: it equals price_base + price_extras + price_tax, and price_fee is reported for information.

door_access_code field is added to the response only if the requesting app has smart_locks scope

guests_breakdown and each of its keys appear only when iGMS holds a value for that reservation. Treat an absent key as unknown rather than zero. A present 0 is likewise not proof the platform reported zero — some integrations store 0 as a default for a category the platform never sent. The categories do not necessarily sum to number_of_guests, which some platforms count over adults and children only.

comments and special_requests fields are added to the response only if the requesting app has messaging scope. comments (string[], e.g. ["I need a wake up service"]) and special_requests (object, request name to text, e.g. {"smoking preference": "Non-Smoking"}) hold the guest's remarks and special requests for a Booking.com booking, and are null for other platforms. A Booking.com booking without them has comments: [] and special_requests: null.