Retrieve the optimized calendar for a single listing

Use this endpoint to retrieve daily calendar availability and pricing for a given listing ID and date range with optimized response format.

View Parameter Behavior:

  • view=compact (default): Returns minimal data without blockIds array and detailed blocks object for better performance
  • view=full: Returns complete data including blockIds array for each calendar day and detailed blocks object with full block information

IMPORTANT: Multi-unit calendar availability is determined by unit allotment, not its status field. To calculate if a multi-unit has availability, use the following formula:

const isAvailable = _.isNumber(currentDay.allotment)?
currentDay.allotment > 0 : currentDay.status === 'available';
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Listing ID

Query Params
string
required

First day to be returned (format: YYYY-MM-DD)

string
required

Last day to be returned (format: YYYY-MM-DD)

boolean

Return day objects including allotment

boolean

Specify ignoreInactiveChildAllotment=true to exclude inactive sub-units from the allotment calculation. Default value is false.

boolean

Specify ignoreUnlistedChildAllotment=true to exclude unlisted sub-units from the allotment calculation. Default value is false.

string
enum
Defaults to compact

Calendar view type for optimized response

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json