Calendar¶
| Endpoint | Method | Scope | Description |
|---|---|---|---|
/api/v1/listings/<id>/calendar/ |
GET | listings:read |
Get calendar data for a listing |
Try it out
Explore parameters, schemas, and live requests in the Swagger UI.
Get Listing Calendar¶
Returns daily calendar data for a listing, including pricing, availability, and pricing factors. Filter by date range using filter[start-date] and filter[end-date] (defaults to today through today + 365 days).
Calendar price fields are returned in the currency configured for the user who owns the listing.
Availability Values¶
| Value | Description |
|---|---|
available |
The date is available to be booked |
booked |
The date has a corresponding reservation |
blocked |
The date is blocked off for a hold |
unavailable |
The date cannot be booked for an unknown reason |
Price Fields¶
| Field | Description |
|---|---|
price |
Beyond Pricing suggested price (shown in the BP dashboard) |
price-modeled |
Price modeled by Beyond Pricing's algorithm |
price-posted |
Last price posted to the channel/PMS |
Tip
Use price-posted when you need the price that will actually be quoted if a booking is made. Fall back to price if price-posted is null.