Params

NameTypeRequirenessDefault valueDescription
property_uidstringrequirednoneUID of property.
from_datestringrequirednoneYYYY-MM-DD First date of the period.
to_datestringrequirednoneYYYY-MM-DD Last date of the period.

Description

Returns the property's calendar data for the period (no more than a year)

This endpoint requires one of the following scopes: calendar-control, direct-bookings, pricing-management, external-cleaning-management

Response sample

{
    "data": [
        {
            "date": "2019-09-07",
            "currency": "CAD",
            "is_available": 1,
            "price": 300,
            "notes": "weekend",
            "min_stay": 2
        }
    ],
    "meta": {
        "page": 1,
        "has_next_page": true
    }
}
  • 'price' is the nightly price for the date before applying Channel Markups values.
  • 'min_stay' is the minimum nights value for the date.
  • 'base_price' is deprecated and is always equal to 'price'
  • 'base_min_stay' is deprecated and is always equal to 'min_stay'