Skip to main content

v2

Welcome to the Calry Vacation Rental API v2 reference documentation!

You can use this API to integrate with Calry and pull data from or push data to integrations that your users have authorized.

v1 to v2 Migration Guide​

There are 2 versions of Calry Unified APIs:

  • v1: to be deprecated by 15th June. Bug fixes and added features will be discontinued by 15th April.
  • v2: to be the active supported version.

Key things to note:

  • This version update is only applicable for Calry Unified APIs. This is NOT applicable for our other features like system APIs, OAuth app URLs, Third-party webhooks and Calry webhooks.
  • If you're using Real-time webhooks, you will have to make parser updates to store the added objects/fields.
  • You will not have to make any changes for your existing integration accounts.

To make calls to v2, update your requests to use the new endpoints. Some endpoints take different parameters or return different data; make sure you check out the API documentation of unified API end-points.

Key Differences between v1 and v2​

New end-points added to v2:​

Removed end-points from v1:​

Update on existing end-points or entities:​

  • Get all Properties

    • Change in Definition:

      Property is a physical rental space that holds one or more room types. While Properties were listable/bookable in Calry v1 end-points, in v2, Room types are now the bookable entity. A property includes essential details like its name, description, roomTypes and thumbnail picture.

      For PMSs that don’t support room types natively (like Hostfully, Hostaway, Guesty etc), we assign a default room type with the same ID as the property. This helps you keep the schema consistent across all PMSs.

      Room Type is the primary listable/bookable entity in Calry v2 end-points. It defines the type of accommodation being offered, such as a studio, deluxe suite, or twin room. Each room type in v2 may contain multiple units under it. How it works depends on the PMS:

      • If the PMS doesn’t support room types natively (e.g., Hostfully), the roomTypeId is the same as the propertyId.
      • If the PMS does (e.g., Beds24, Lodgify, Cloudbeds), a property can have multiple room types, each with its own units.

      This update keeps the data model unified, making it easier to work with both types of PMS systems, helping you onboard vacation rental properties, serviced apartments and independent hotels.

    • Added to response: roomTypes

    • Removed from response: pictures, maximumNights, minimumNights, maxOccupancy, rooms