Apaleo

Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses

Get a units list

Get the list of units.

you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Get a unit

Get a unit by id.

you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Create a unit

Use this call to create a new unit.

you must have at least one of these scopes: ‘units.create, setup.manage’.

Create a unit attribute

Use this call to create a new unit attribute.

you must have at least one of these scopes: ‘unitattributes.create, setup.manage’.

Creates a property

Use this call to create a new property.

you must have at least one of these scopes: ‘properties.create, setup.manage’.

Check if a property exists

Check if a property exists by id.

you need to be authorized (no particular scope required)

Get unit attribute by id

you must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Check if a unit attribute exists

you must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Archive a property

Use this endpoint to archive an existing live property this operation set the isarchived flag to true

you must have at least one of these scopes: ‘properties.manage, setup.manage’.

Get a unit group

Get a unit group by id.

you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Check if a unit exists

Check if a unit exists by id.

you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Get unit attribute list

you must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Create a unit group

Use this call to create a new unit group.

you must have at least one of these scopes: ‘unitgroups.create, setup.manage’.

Move property to live

Use this endpoint to move an existing test property to live this operation changes the property status to ‘live’

you must have at least one of these scopes: ‘properties.manage, setup.manage’.

Replace a unit group

Use this call to modify a unit group.

you must have at least one of these scopes: ‘unitgroups.manage, setup.manage’.

Check if a unit group exists

Check if a unit group exists by id.

you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Clones a property

Use this call to clone a specific property. this operation creates a new property with inventory and rate plans from the specified property.

you must have at least one of these scopes: ‘properties.create, setup.manage’.

Reset a test property and delete all transactional data

This endpoint deletes transactional data for a property in ‘test’ status. requires ‘properties.manage’ or ‘setup.manage’ scopes.

Returns a list of supported countries

Returns a list of iso country codes that could be used to create properties.

you need to be authorized (no particular scope required)

Create multiple units

Use this call to create multiple units, following a naming rule.

you must have at least one of these scopes: ‘units.create, setup.manage’.

Returns number of units

Returns number of units matching the filter criteria

you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Deletes unit attribute

you must have at least one of these scopes: ‘unitattributes.delete, setup.manage’.

Delete a unit

Use this call to delete a unit.

you must have at least one of these scopes: ‘units.delete, setup.manage’.

Delete a unit group

Use this call to delete a unit group.

you must have at least one of these scopes: ‘unitgroups.delete, setup.manage’.

Get all unit groups or all unit groups for a property

Get the list of unit groups.

you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Return total count of properties

you need to be authorized (no particular scope required)

Returns number of unit groups

Returns number of unit groups matching the filter criteria

you must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Get a properties list

Get the list of properties.

you need to be authorized (no particular scope required)

Get a property

Get a property by id.

you need to be authorized (no particular scope required)

Get Started

Documentation

Changelog

Legal