Properties Calendar

Endpoint

GET /partners/properties/calendar

Description

Returns availability calendar data for a list of properties. Each entry in the response contains the property ID and a list of calendar ranges covering today through the next 3 years.

Request

Headers

Header	Required	Description
Authorization	Yes	Bearer token obtained from the authentication endpoint. Format: `Bearer {ACCESS_TOKEN}`
Api-Version	No	API version to use. Defaults to `1`. Currently only `1` is supported.

Query Parameters

Parameter	Type	Required	Description
ids	string[] array of strings	Yes	Comma-separated list of property IDs to retrieve calendars for. Must contain between 1 and 100 IDs (e.g., `?ids=id1,id2,id3`).

Response

Status Codes

Code	Description
200	Success
400	Bad request — see error codes below
401	Unauthorized — invalid or expired access token

Error Codes

When the request fails, the response body includes an error code and message:

Code	HTTP Status	Description
`EMPTY_IDS`	400	At least one property ID is required
`TOO_MANY_IDS`	400	Number of IDs exceeds the maximum of 100
`INVALID_PROPERTY_ID`	400	One or more provided IDs are not in a valid format
`UNSUPPORTED_API_VERSION`	400	The provided `Api-Version` header value is not supported

Response Body

The response is an array of calendar objects, one per requested property ID. Property IDs that are not valid are silently excluded from the response.

PropertyCalendarInfo

Field	Type	Required	Description
id	string	Yes	Property ID. Corresponds to the `id` field in PropertyBasicInfo
calendar	Object[]	Yes	List of calendar date ranges covering today through the next 3 years. See PropertyCalendar

PropertyCalendar

A continuous date range where all attributes are identical.

Field	Type	Required	Description
from	string	Yes	Start date of the range. Format: `yyyy-MM-dd` (e.g., `2026-04-01`)
to	string	Yes	End date of the range. Format: `yyyy-MM-dd` (e.g., `2026-04-15`)
dailyPrice	decimal	Yes	Daily price for this period
minNights	integer	Yes	Minimum number of nights required for a booking starting in this date range
availability	string	Yes	`AVAILABLE` or `NOT_AVAILABLE`. See CalendarAvailability
closedToArrival	boolean	Yes	Whether guests cannot check in during this period
closedToDeparture	boolean	Yes	Whether guests cannot check out during this period

CalendarAvailability

Value	Description
`AVAILABLE`	The property is available for booking
`NOT_AVAILABLE`	The property is not available for booking

Example Response

[
  {
    "id": "507f1f77bcf86cd799439011",
    "calendar": [
      {
        "from": "2026-03-11",
        "to": "2026-03-20",
        "dailyPrice": 125.50,
        "minNights": 7,
        "availability": "AVAILABLE",
        "closedToArrival": false,
        "closedToDeparture": false
      },
      {
        "from": "2026-03-21",
        "to": "2026-03-21",
        "dailyPrice": 130.00,
        "minNights": 7,
        "availability": "AVAILABLE",
        "closedToArrival": false,
        "closedToDeparture": false
      },
      {
        "from": "2026-03-22",
        "to": "2026-03-31",
        "dailyPrice": 135.00,
        "minNights": 7,
        "availability": "NOT_AVAILABLE",
        "closedToArrival": true,
        "closedToDeparture": false
      },
      {
        "from": "2026-04-01",
        "to": "2026-04-01",
        "dailyPrice": 135.00,
        "minNights": 7,
        "availability": "NOT_AVAILABLE",
        "closedToArrival": false,
        "closedToDeparture": true
      },
      {
        "from": "2026-04-02",
        "to": "2026-04-30",
        "dailyPrice": 150.00,
        "minNights": 14,
        "availability": "AVAILABLE",
        "closedToArrival": false,
        "closedToDeparture": false
      }
    ]
  }
]

Note: Days with identical pricing and availability are automatically merged into a single range. In the example above, March 11–20 and March 22–31 are multi-day ranges where all attributes are identical within each period. March 21 and April 1 appear as single-day entries because one or more attributes differ from the surrounding days.

Properties Calendar

On this page