Params

Name Type Requireness Default value Description
booking_uids string optional none List of comma separated booking UIDs
booking_status string optional none One of available booking statuses (see the corresponding filters section)
platform_type string optional none List of comma separated platform types (see the corresponding filters section). This filter returns bookings related to one of mentioned platform types
from_date string optional none Hide bookings ended before this date
to_date string optional none Hide bookings which will be started after this date
from_created_date string optional none Hide bookings which created before this date
to_created_date string optional none Hide bookings which created after this date
from_updated_date string optional none Hide bookings which updated before this date
to_updated_date string optional none Hide bookings which updated after this date
page int optional 1 Page number for pagination

Description

List of active bookings

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

Response sample

{
    "data": [
        {
            "booking_uid": "AXFNTT_airbnb_123",
            "reservation_code": "AXFNTT",
            "readable_reservation_code": "AXFNTT",
            "booking_status": "accepted",
            "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",      
            "number_of_guests": 2,
            "price": {
                "currency": "USD",
                "price_base": 100.00,                           
                "price_extras": 10.00,                            
                "price_fee": 16.00,                                                                       
                "price_tax": 10.00,                            
                "price_total": 94.00                            
            },
            "door_access_code": null
        }
    ],
    "meta": {
        "page": 1,
        "has_next_page": true
    }
}

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