Apaleo Integration
Apaleo API Operations
Browse all 29 operations available for Apaleo workflow automation.
payments
29 operationsAPALEO_ARCHIVE_A_PROPERTYArchive a property
Use this endpoint to archive an existing live property This operation set the IsArchived flag to true<br>You must have at least one of these scopes:…
APALEO_CHECK_IF_A_PROPERTY_EXISTSCheck if a property exists
Check if a property exists by id.<br>You need to be authorized (no particular scope required)
APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTSCheck if a unit attribute exists
Check if a unit attribute exists<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
APALEO_CHECK_IF_A_UNIT_EXISTSCheck if a unit exists
Check if a unit exists by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
APALEO_CHECK_IF_A_UNIT_GROUP_EXISTSCheck if a unit group exists
Check if a unit group exists by id.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
APALEO_CLONES_A_PROPERTYClones a property
Use this call to clone a specific property.
APALEO_CREATE_A_UNITCreate a unit
Use this call to create a new unit.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
APALEO_CREATE_A_UNIT_ATTRIBUTECreate a unit attribute
Use this call to create a new unit attribute.<br>You must have at least one of these scopes: 'unitattributes.create, setup.manage'.
APALEO_CREATE_A_UNIT_GROUPCreate a unit group
Use this call to create a new unit group.<br>You must have at least one of these scopes: 'unitgroups.create, setup.manage'.
APALEO_CREATE_MULTIPLE_UNITSCreate multiple units
Use this call to create multiple units, following a naming rule.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
APALEO_CREATES_A_PROPERTYCreates a property
Use this call to create a new property.<br>You must have at least one of these scopes: 'properties.create, setup.manage'.
APALEO_DELETE_A_UNITDelete a unit
Use this call to delete a unit.<br>You must have at least one of these scopes: 'units.delete, setup.manage'.
APALEO_DELETE_A_UNIT_GROUPDelete a unit group
Use this call to delete a unit group.<br>You must have at least one of these scopes: 'unitgroups.delete, setup.manage'.
APALEO_DELETES_UNIT_ATTRIBUTEDeletes unit attribute
Deletes unit attribute<br>You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
APALEO_GET_A_PROPERTIES_LISTGet a properties list
Get the list of properties.<br>You need to be authorized (no particular scope required)
APALEO_GET_A_PROPERTYGet a property
Get a property by id.<br>You need to be authorized (no particular scope required)
APALEO_GET_A_UNITGet a unit
Get a unit by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
APALEO_GET_A_UNIT_GROUPGet a unit group
Get a unit group by id.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
APALEO_GET_A_UNITS_LISTGet a units list
Get the list of units.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
APALEO_GET_UNIT_ATTRIBUTE_BY_IDGet unit attribute by id
Get unit attribute by id<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
APALEO_GET_UNIT_ATTRIBUTE_LISTGet unit attribute list
Get unit attribute list<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
APALEO_LIST_UNIT_GROUPSList Unit Groups
Get the list of unit groups.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
APALEO_MOVE_PROPERTY_TO_LIVEMove property to live
Use this endpoint to move an existing test property to live This operation changes the property status to 'Live'<br>You must have at least one of these scopes:…
APALEO_REPLACE_A_UNIT_GROUPReplace a unit group
Use this call to modify a unit group.<br>You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.
APALEO_RESET_PROPERTY_DATAReset Property Data
This endpoint deletes transactional data for a property in 'Test' status.
APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIESReturn total count of properties
Return total count of properties<br>You need to be authorized (no particular scope required)
APALEO_RETURNS_A_LIST_OF_SUPPORTED_COUNTRIESReturns a list of supported countries
Returns a list of ISO country codes that could be used to create properties.<br>You need to be authorized (no particular scope required)
APALEO_RETURNS_NUMBER_OF_UNIT_GROUPSReturns number of unit groups
Returns number of unit groups matching the filter criteria<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
APALEO_RETURNS_NUMBER_OF_UNITSReturns number of units
Returns number of units matching the filter criteria<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.