GET
/
api
/
v1
/
availability
/
{listingID}
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "date": "2025-12-15",
      "status": "AVAILABLE",
      "price": 200,
      "minimumNights": 2,
      "maximumNights": 30,
      "currency": "USD",
      "originalPrice": 250,
      "priceModifications": {
        "defaultDiscount": {
          "percentage": 10,
          "value": 25
        },
        "markup": {
          "percentage": 10,
          "value": 25
        },
        "promotionDiscount": {
          "percentage": 10,
          "value": 25
        }
      }
    }
  ],
  "meta": {
    "total": 100,
    "limit": 15,
    "totalPages": 8,
    "current": 2,
    "previous": 1,
    "next": 3
  },
  "avgNightlyPrice": 150
}

Authorizations

​
x-calry-api-key
string
header
required

Headers

​
x-calry-tenant-id
string

Optional tenant ID to specify which tenant to operate as. Controls access to listings and their availability. If not provided, the default tenant will be used.

Path Parameters

​
listingID
string
required

Unique identifier of the listing

Example:

"123e4567-e89b-12d3-a456-426614174000"

Query Parameters

​
startDate
string

Start date for availability period (ISO format)

Example:

"2025-04-01"

​
endDate
string

End date for availability period (ISO format)

Example:

"2025-12-31"

​
status
enum<string>

Filter by availability status

Available options:
AVAILABLE,
NOT_AVAILABLE
​
displayCurrency
string

Currency to display pricing in (ISO 4217)

Example:

"USD"

​
page
number
default:1

Page number for pagination

Required range: x >= 1
Example:

1

​
limit
number
default:90

Number of days per page

Required range: 1 <= x <= 730
Example:

90

​
includePrice
boolean
default:false

Whether to include the average nightly price in the response

Example:

true

Response

200
application/json

Availability records retrieved successfully

The response is of type object.