Get Availability of the Property with Dates

Get the availability of a property for a given date range.

HTTP Request

GET https://dev.calry.app/api/v1/vrs/availability/{propertyId}

Header	Value
Authorization	Bearer YOUR_ACCESS_TOKEN
workspaceId	YOUR_WORKSPACE_ID
integrationAccountId	YOUR_INTEGRATION_ACCOUNT_ID

Query Parameters

Parameter	Type	Description
rates	bool	Required. Determines whether nightly rates and stay information should be included in the response.
startDate	string	Required. The start date of the availability check in YYYY-MM-DD format.
endDate	string	Required. The end date of the availability check in YYYY-MM-DD format.
roomId	string	Optional. The roomId for which availability check is done.

• Note that the roomId parameter is optional. Some PMS systems require the room id to get the availability of the property. If the room id is not provided, the API will return the availability of the property without the room id.

Example Request

curl --location 'https://dev.calry.app/api/v1/vrs/availability/212815?startDate=2024-02-01&endDate=2024-02-25&rates=true' \
--header 'Authorization: Bearer eyJraWQiOiJzLWJhNjY5YzZhLTE0OTktNDQ1MS05MjFhLTExYzQyNDZhZTQ1NSIsInR5cCI6IkpXVCIsImFsZyI6IlJTMjU2In0.eyJpc3MiOiJodHRwOi8vbG9jYWxob3N0OjMwMDAvYXV0aCIsInVzZXJJZCI6IjE2NjI0N2U3LTNiYjktNDExYy05ZDBjLTBjMDY3ZTg0ODhmNCIsIndvcmtzcGFjZUlkIjoiZjAzYzNjOTctNDJjZC00MzMwLTk5OWMtZmM5OTA2ZDgzMzY1IiwibmFtZSI6InNhZGFzIiwic291cmNlIjoibWljcm9zZXJ2aWNlIiwiaWF0IjoxNzA1OTI4ODQ5LCJleHAiOjIyOTA4MTMwMDUxfQ.Vft46kRiDKRXA8u7iOB1USkvECs3bI5qmT0kpU2cpogONrg0HFfoUNj658uBRLoyoUr_tq2TrUqf7S1MGqf58I_1zlpKJ0-7wLlKCA5atWGXDPJqaY6xqsJGwqf3z6Yb1QR7o_r3YsLUizSzHc7BT2wFdHaIBydUyNG_kQEogyFWieMTNFFHwU0aUq1LoSyyIL5nWoDeM-pFd0nd659_HOP1ZlvJIGWjVYB94-IrF1q-i4NKokhx6WEaftuIpSKLEsJAskuDWIzvittcq4RszAvaAVHUOKZd907JASGNpzBF812vggr_HmXVAxdVSo5cmzexh-fcgXfe8npXgkiEhg' \
--header 'workspaceId: f03c3c97-42cd-4330-999c-fc9906d83365' \
--header 'integrationAccountId: 526bcda0-7312-449f-8525-66048fd03fb7'

Example Response

{
  "success": true,
  "data": {
    "propertyId": "1642089b-a7f6-43d5-b3dc-4b4801291ad1",
    "dateWiseAvailability": [
      {
        "date": "2024-08-30",
        "status": "NOT_AVAILABLE",
        "reservationIds": [
          "f95e0ac8-7eb7-4464-b60f-9788f3d55be0"
        ],
        "price": {
          "amount": 95,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-08-31",
        "status": "NOT_AVAILABLE",
        "reservationIds": [
          "f95e0ac8-7eb7-4464-b60f-9788f3d55be0"
        ],
        "price": {
          "amount": 95,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-01",
        "status": "NOT_AVAILABLE",
        "reservationIds": [
          "f95e0ac8-7eb7-4464-b60f-9788f3d55be0"
        ],
        "price": {
          "amount": 98,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-02",
        "status": "NOT_AVAILABLE",
        "reservationIds": [
          "f95e0ac8-7eb7-4464-b60f-9788f3d55be0",
          ""
        ],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-03",
        "status": "AVAILABLE",
        "reservationIds": [
          ""
        ],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-04",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-05",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-06",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-07",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-08",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-09",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      },
      {
        "date": "2024-09-10",
        "status": "AVAILABLE",
        "reservationIds": [],
        "price": {
          "amount": 88,
          "currency": "USD"
        },
        "minimumNights": 30
      }
    ]
  }
}