Skip to main content
Apaleo logo
  • Category: scheduling & booking
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 29
  • Triggers: 0
  • Slug: APALEO
  • Version: 20261030_00

Tools

Slug: APALEO_ARCHIVE_A_PROPERTYUse 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’.

Input Parameters

string
required
The id of the property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CHECK_IF_A_PROPERTY_EXISTSCheck if a property exists by id.
You need to be authorized (no particular scope required)

Input Parameters

string
required
The id of the property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTSCheck if a unit attribute exists
You must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Input Parameters

string
required
The id of the unit attribute.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CHECK_IF_A_UNIT_EXISTSCheck if a unit exists by id.
You must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Input Parameters

string
required
The id of the unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CHECK_IF_A_UNIT_GROUP_EXISTSCheck if a unit group exists by id.
You must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Input Parameters

string
required
The id of the unit group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CLONES_A_PROPERTYUse 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’.

Input Parameters

string
required
The id of the property.
string
required
The code for the property that can be shown in reports and table views
object
required
The name for the property
string
required
The Tax-ID of the company running the property, as it should appear on invoices
string
required
The time zone name of the property from the IANA Time Zone Database. (see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
string
required
The legal name of the company running the property.
object
The description for the property
string
required
The currency a property works with.
object
required
The payment terms used for all rate plans
string
City
string
Bic
string
Bank
string
Iban
string
The managing director(s) of the company, as they should appear on invoices
string
required
The default check-in time
A time (without fractional second part) as defined in the <a href=“https://en.wikipedia.org/wiki/ISO_8601”&gt;ISO8601:2004&lt;/a>
string
required
The default check-out time
A time (without fractional second part) as defined in the <a href=“https://en.wikipedia.org/wiki/ISO_8601”&gt;ISO8601:2004&lt;/a>
string
Postalcode
string
The ISO 3166-2 code
string
The country code, in ISO 3166-1 alpha-2 code
string
Addressline1
string
Addressline2
string
required
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CREATE_A_UNITUse this call to create a new unit.
You must have at least one of these scopes: ‘units.create, setup.manage’.

Input Parameters

string
required
The name for the unit
string ("Clean" | "CleanToBeInspected" | "Dirty")
Condition of the unit
array
Collection of user defined attributes of unit
integer
required
Maximum number of persons for the unit
string
required
The id of the property where the unit will be created
object
required
The description for the unit
string
The id of the unit group
array
The list of units this unit is composed of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CREATE_A_UNIT_ATTRIBUTEUse this call to create a new unit attribute.
You must have at least one of these scopes: ‘unitattributes.create, setup.manage’.

Input Parameters

string
required
The name of the unit attribute
string
The description of the unit attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CREATE_A_UNIT_GROUPUse this call to create a new unit group.
You must have at least one of these scopes: ‘unitgroups.create, setup.manage’.

Input Parameters

string
required
The code for the unit group that can be shown in reports and table views
object
required
The name for the unit group
integer
The unit group rank Restrictions: - Should be greater or equal to one
string ("BedRoom" | "MeetingRoom" | "EventSpace" | "ParkingLot" | "Other")
The unit group type
integer
required
Maximum number of persons for the unit group
string
required
The id of the property where unit group will be created
object
required
The description for the unit group
array
The list of connected unit groups this unit group is composed of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CREATE_MULTIPLE_UNITSUse this call to create multiple units, following a naming rule.
You must have at least one of these scopes: ‘units.create, setup.manage’.

Input Parameters

array
required
Units

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_CREATES_A_PROPERTYUse this call to create a new property.
You must have at least one of these scopes: ‘properties.create, setup.manage’.

Input Parameters

string
required
The code for the property that can be shown in reports and table views
object
required
The name for the property
string
required
The Tax-ID of the company running the property, as it should appear on invoices
string
required
The time zone name of the property from the IANA Time Zone Database. (see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
string
required
The legal name of the company running the property.
object
The description for the property
string
required
The currency a property works with.
object
required
The payment terms used for all rate plans
string
City
string
Bic
string
Bank
string
Iban
string
The managing director(s) of the company, as they should appear on invoices
string
required
The default check-in time
A time (without fractional second part) as defined in the <a href=“https://en.wikipedia.org/wiki/ISO_8601”&gt;ISO8601:2004&lt;/a>
string
required
The default check-out time
A time (without fractional second part) as defined in the <a href=“https://en.wikipedia.org/wiki/ISO_8601”&gt;ISO8601:2004&lt;/a>
string
Postalcode
string
The ISO 3166-2 code
string
The country code, in ISO 3166-1 alpha-2 code
string
Addressline1
string
Addressline2
string
required
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_DELETE_A_UNITUse this call to delete a unit.
You must have at least one of these scopes: ‘units.delete, setup.manage’.

Input Parameters

string
required
The id of the unit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_DELETE_A_UNIT_GROUPUse this call to delete a unit group.
You must have at least one of these scopes: ‘unitgroups.delete, setup.manage’.

Input Parameters

string
required
The id of the unit group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_DELETES_UNIT_ATTRIBUTEDeletes unit attribute
You must have at least one of these scopes: ‘unitattributes.delete, setup.manage’.

Input Parameters

string
required
Id of unit attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_A_PROPERTIES_LISTGet the list of properties.
You need to be authorized (no particular scope required)

Input Parameters

array
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
array
Filter result by property status
integer
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
integer
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
array
Filter result by country code
boolean
Include archived properties in the result. If not set, or set to false, it only returns non-archived properties

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_A_PROPERTYGet a property by id.
You need to be authorized (no particular scope required)

Input Parameters

string
required
The id of the property.
array
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
array
List of two-letter language codes (ISO Alpha-2), or [“all”] for all languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_A_UNITGet a unit by id.
You must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Input Parameters

string
required
The id of the unit.
array
List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits. All other values will be silently ignored.
array
List of two-letter language codes (ISO Alpha-2), or [“all”] for all languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_A_UNIT_GROUPGet a unit group by id.
You must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Input Parameters

string
required
The id of the unit group.
array
List of all embedded resources that should be expanded in the response. Possible values are: property, connectedUnitGroups. All other values will be silently ignored.
array
List of two-letter language codes (ISO Alpha-2), or [“all”] for all languages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_A_UNITS_LISTGet the list of units.
You must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Input Parameters

array
List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, connectedUnits. All other values will be silently ignored.
integer
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
string ("Clean" | "CleanToBeInspected" | "Dirty")
Return units with a specific condition
boolean
Return only occupied or vacant units
integer
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
string
Return units for specific property
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
string
Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use UnitGroupIds instead</b>
array
Return units with the specific unit groups
string ("OutOfService" | "OutOfOrder" | "OutOfInventory")
Return units with the specific maintenance type
array
Return units with the specific unit attributes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_UNIT_ATTRIBUTE_BY_IDGet unit attribute by id
You must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Input Parameters

string
required
The id of the unit attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_GET_UNIT_ATTRIBUTE_LISTGet unit attribute list
You must have at least one of these scopes: ‘unitattributes.read, setup.read, setup.manage’.

Input Parameters

integer
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
integer
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_LIST_UNIT_GROUPSGet the list of unit groups.
You must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Input Parameters

array
List of all embedded resources that should be expanded in the response. Possible values are: property, connectedUnitGroups. All other values will be silently ignored.
integer
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
integer
Page number, 1-based. Default value is 1 (if this is not set or not positive). Results in 204 if there are no items on that page.
string
Return unit groups for specific property
array
Unitgrouptypes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_MOVE_PROPERTY_TO_LIVEUse 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’.

Input Parameters

string
required
The id of the property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_REPLACE_A_UNIT_GROUPUse this call to modify a unit group.
You must have at least one of these scopes: ‘unitgroups.manage, setup.manage’.

Input Parameters

string
required
The id of the unit group.
object
required
The name for the unit group
integer
The unit group rank Restrictions: - Should be greater or equal to one
integer
Maximum number of persons for the unit group. If this value is increased, the surcharges for the related rate plans must be specified in order for the rate plans to be sellable for the new possible occupancies.
object
required
The description for the unit group
array
The list of connected unit groups this unit group is composed of

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_RESET_PROPERTY_DATAThis endpoint deletes transactional data for a property in ‘Test’ status. Requires ‘properties.manage’ or ‘setup.manage’ scopes.

Input Parameters

string
required
The id of the property

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_RETURNS_A_LIST_OF_SUPPORTED_COUNTRIESReturns a list of ISO country codes that could be used to create properties.
You need to be authorized (no particular scope required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_RETURNS_NUMBER_OF_UNIT_GROUPSReturns number of unit groups matching the filter criteria
You must have at least one of these scopes: ‘unitgroups.read, setup.read, setup.manage’.

Input Parameters

string
Return unit groups for specific property
array
Unitgrouptypes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_RETURNS_NUMBER_OF_UNITSReturns number of units matching the filter criteria
You must have at least one of these scopes: ‘units.read, setup.read, setup.manage’.

Input Parameters

string ("Clean" | "CleanToBeInspected" | "Dirty")
Return units with a specific condition
boolean
Return only occupied or vacant units
string
Return units for specific property
string
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
string
Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use UnitGroupIds instead</b>
array
Return units with the specific unit groups
string ("OutOfService" | "OutOfOrder" | "OutOfInventory")
Return units with the specific maintenance type
array
Return units with the specific unit attributes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIESReturn total count of properties
You need to be authorized (no particular scope required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not