Reference

Returns a list of supported countries

Retrieves a complete list of ISO country codes available for creating properties in your Apaleo system. Use this to validate and ensure you're setting up properties in supported locations.

Creates a property

Add a new property to your Apaleo account to start managing bookings and reservations for additional locations or rental units.

Get a properties list

Retrieve a complete list of all your properties in the system to view and manage your accommodation portfolio. This helps you stay organized and access key information about each location you operate.

Get a property

Retrieve detailed information about a specific property in your Apaleo account, including its configuration, amenities, and settings.

Archive a property

Mark a property as archived to remove it from active listings and operations without permanently deleting its data. This is useful when you're no longer accepting bookings or managing a property but want to retain its historical information.

Check if a property exists

Verify whether a specific property is registered in your Apaleo account by its unique identifier, helping you validate property data before performing operations.

Clones a property

Creates a duplicate of an existing property including all its inventory and rate plans, allowing you to quickly set up new locations with the same configuration without manual recreation.

Move property to live

Activate a test property in your Apaleo account to make it available for real bookings and operations. This transitions your property from testing mode to live production status.

Reset Property Data

Clears all transactional data from a test property to start fresh with a clean slate, allowing you to reset your testing environment without creating a new property.

Return total count of properties

Get the total number of properties in your Apaleo account to understand your portfolio size and track growth across your properties.

Create a unit group

Create a new unit group to organize and categorize your property units for easier management and reporting in your accommodation business.

Create multiple units

Bulk create multiple accommodation units in your property management system using a consistent naming pattern, saving time when setting up or expanding your property inventory.

Get a units list

Retrieve a complete list of all units (rooms, apartments, or properties) in your accommodation business to view inventory and property information.

Check if a unit attribute exists

Verifies whether a specific custom attribute exists for a room or unit in your property management system, allowing you to confirm data structure before performing operations.

Check if a unit exists

Verify whether a specific unit (room, space, or property) exists in your Apaleo property management system by its ID. This helps validate unit data before performing operations or prevent errors when managing your accommodation inventory.

Check if a unit group exists

Verifies whether a specific unit group exists in your Apaleo property management system, useful for validating group identifiers before performing operations on them.

Create a unit

Add a new unit (room, suite, or space) to your property management system so guests can book it. This is essential when expanding your accommodation inventory or setting up your property for the first time.

Create a unit attribute

Create a new custom attribute for your rental units to track specific features, amenities, or characteristics that are important to your property management.

Delete a unit

Remove a unit from your property management system when it's no longer needed or available for booking. This action permanently deletes the unit record and all associated data.

Delete a unit group

Remove a unit group from your property management system when it's no longer needed or when reorganizing your room inventory structure.

Deletes unit attribute

Removes a custom attribute from a hotel unit, allowing you to clean up unit configuration data that's no longer needed or used.

Get a unit

Retrieve detailed information about a specific accommodation unit in your property, including its configuration, status, and attributes. This helps you verify unit details and access information needed for bookings and management.

Get a unit group

Retrieve detailed information about a specific unit group in your property management system, including its configuration and settings. Use this to access unit grouping details for reporting, integration, or management purposes.

Get unit attribute by id

Retrieve detailed information about a specific unit attribute, such as amenities or room features, to understand what properties or characteristics are associated with your accommodations.

Get unit attribute list

Retrieve all available attributes that can be assigned to rooms or units in your property management system. Use this to understand what custom properties and features you can track for each unit.

List Unit Groups

Retrieve all unit groups in your property management system to organize and manage different categories of accommodations.

Replace a unit group

Updates an existing unit group configuration, allowing you to modify properties like name, descriptions, and settings for a group of accommodations in your property management system.

Returns number of unit groups

Retrieves the total count of unit groups in your property management system based on your specified filter criteria, helping you quickly understand your accommodation inventory structure without loading full details.

Returns number of units

Retrieves the total count of units in your property portfolio that match specific filter criteria, helping you quickly understand your inventory without loading full unit details.