Apaleo
Learn how to use Apaleo with Composio
Overview
Enum
APALEO
Description
Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses
Authentication Details
OAUTH2
Actions
APALEO_ARCHIVE_A_PROPERTY
Use this endpoint to archive an existing live property this operation set the isarchived flag to trueyou must have at least one of these scopes: ‘properties.manage, setup.manage’.
Action Parameters
Action Response
APALEO_CHECK_IF_A_PROPERTY_EXISTS
Check if a property exists by id.you need to be authorized (no particular scope required)
Action Parameters
Action Response
APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTS
Check if a unit attribute existsyou must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_CREATES_A_PROPERTY
Use this call to create a new property.you must have at least one of these scopes: ‘properties.create, setup.manage’.
Action Parameters
Action Response
APALEO_CREATE_A_UNIT
Use this call to create a new unit.you must have at least one of these scopes: ‘units.create, setup.manage’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_DELETES_UNIT_ATTRIBUTE
Deletes unit attributeyou must have at least one of these scopes: ‘unitattributes.delete, setup.manage’.
Action Parameters
Action Response
APALEO_DELETE_A_UNIT
Use this call to delete a unit.you must have at least one of these scopes: ‘units.delete, setup.manage’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_GET_A_PROPERTIES_LIST
Get the list of properties.you need to be authorized (no particular scope required)
Action Parameters
Action Response
APALEO_GET_A_PROPERTY
Get a property by id.you need to be authorized (no particular scope required)
Action Parameters
Action Response
APALEO_GET_A_UNIT
Get a unit by id.you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_GET_A_UNITS_LIST
Get the list of units.you must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_GET_UNIT_ATTRIBUTE_BY_ID
Get unit attribute by idyou must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_GET_UNIT_ATTRIBUTE_LIST
Get unit attribute listyou must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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’.
Action Parameters
Action Response
APALEO_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.
Action Parameters
Action Response
APALEO_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)
Action Parameters
Action Response
APALEO_RETURNS_NUMBER_OF_UNITS
Returns number of units matching the filter criteriayou must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_RETURNS_NUMBER_OF_UNIT_GROUPS
Returns number of unit groups matching the filter criteriayou must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.
Action Parameters
Action Response
APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIES
Return total count of propertiesyou need to be authorized (no particular scope required)
Action Parameters
Action Response