Apaleo
Your Toolhouse AI Worker can connect to Apaleo using 29 specialized tools.
Auth Connection
This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under Auth Connections.
Tools (29)
Apaleo Archive A Property
Apaleo Archive A PropertyIntegration name: APALEO_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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the property
Apaleo Check If A Property Exists
Apaleo Check If A Property ExistsIntegration name: APALEO_CHECK_IF_A_PROPERTY_EXISTS
Check if a property exists by id. You need to be authorized (no particular scope required)
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the property.
Apaleo Check If A Unit Attribute Exists
Apaleo Check If A Unit Attribute ExistsIntegration name: APALEO_CHECK_IF_A_UNIT_ATTRIBUTE_EXISTS
Check if a unit attribute exists You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit attribute.
Apaleo Check If A Unit Exists
Apaleo Check If A Unit ExistsIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit.
Apaleo Check If A Unit Group Exists
Apaleo Check If A Unit Group ExistsIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit group.
Apaleo Clones A Property
Apaleo Clones A PropertyIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the property.
code
string
✅
—
The code for the property that can be shown in reports and table views
name
object
✅
—
The name for the property
taxId
string
✅
—
The Tax-ID of the company running the property, as it should appear on invoices
timeZone
string
✅
—
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)
companyName
string
✅
—
The legal name of the company running the property.
description
object
—
The description for the property
currencyCode
string
✅
—
The currency a property works with.
paymentTerms
object
✅
—
The payment terms used for all rate plans
location__city
string
—
City
bankAccount__bic
string
—
Bic
bankAccount__bank
string
—
Bank
bankAccount__iban
string
—
Iban
managingDirectors
string
—
The managing director(s) of the company, as they should appear on invoices
defaultCheckInTime
string
✅
—
The default check-in time A time (without fractional second part) as defined in the ISO8601:2004
defaultCheckOutTime
string
✅
—
The default check-out time A time (without fractional second part) as defined in the ISO8601:2004
location__postalCode
string
—
Postalcode
location__regionCode
string
—
The ISO 3166-2 code
location__countryCode
string
—
The country code, in ISO 3166-1 alpha-2 code
location__addressLine1
string
—
Addressline1
location__addressLine2
string
—
Addressline2
commercialRegisterEntry
string
✅
—
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices
Apaleo Create A Unit
Apaleo Create A UnitIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
name
string
✅
—
The name for the unit
condition
string
—
Condition of the unit
attributes
array
—
Collection of user defined attributes of unit
maxPersons
integer
✅
—
Maximum number of persons for the unit
propertyId
string
✅
—
The id of the property where the unit will be created
description
object
✅
—
The description for the unit
unitGroupId
string
—
The id of the unit group
connectedUnits
array
—
The list of units this unit is composed of
Apaleo Create A Unit Attribute
Apaleo Create A Unit AttributeIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
name
string
✅
—
The name of the unit attribute
description
string
—
The description of the unit attribute
Apaleo Create A Unit Group
Apaleo Create A Unit GroupIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
code
string
✅
—
The code for the unit group that can be shown in reports and table views
name
object
✅
—
The name for the unit group
rank
integer
—
The unit group rank Restrictions: - Should be greater or equal to one
type
string
—
The unit group type
maxPersons
integer
✅
—
Maximum number of persons for the unit group
propertyId
string
✅
—
The id of the property where unit group will be created
description
object
✅
—
The description for the unit group
connectedUnitGroups
array
—
The list of connected unit groups this unit group is composed of
Apaleo Create Multiple Units
Apaleo Create Multiple UnitsIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
units
array
✅
—
Units
Apaleo Creates A Property
Apaleo Creates A PropertyIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
code
string
✅
—
The code for the property that can be shown in reports and table views
name
object
✅
—
The name for the property
taxId
string
✅
—
The Tax-ID of the company running the property, as it should appear on invoices
timeZone
string
✅
—
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)
companyName
string
✅
—
The legal name of the company running the property.
description
object
—
The description for the property
currencyCode
string
✅
—
The currency a property works with.
paymentTerms
object
✅
—
The payment terms used for all rate plans
location__city
string
—
City
bankAccount__bic
string
—
Bic
bankAccount__bank
string
—
Bank
bankAccount__iban
string
—
Iban
managingDirectors
string
—
The managing director(s) of the company, as they should appear on invoices
defaultCheckInTime
string
✅
—
The default check-in time A time (without fractional second part) as defined in the ISO8601:2004
defaultCheckOutTime
string
✅
—
The default check-out time A time (without fractional second part) as defined in the ISO8601:2004
location__postalCode
string
—
Postalcode
location__regionCode
string
—
The ISO 3166-2 code
location__countryCode
string
—
The country code, in ISO 3166-1 alpha-2 code
location__addressLine1
string
—
Addressline1
location__addressLine2
string
—
Addressline2
commercialRegisterEntry
string
✅
—
The entry in the Commercial Reigster of the company running the property, as it should appear on invoices
Apaleo Delete A Unit
Apaleo Delete A UnitIntegration name: APALEO_DELETE_A_UNIT
Use this call to delete a unit. You must have at least one of these scopes: 'units.delete, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit.
Apaleo Delete A Unit Group
Apaleo Delete A Unit GroupIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit group.
Apaleo Deletes Unit Attribute
Apaleo Deletes Unit AttributeIntegration name: APALEO_DELETES_UNIT_ATTRIBUTE
Deletes unit attribute You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
Id of unit attribute
Apaleo Get A Properties List
Apaleo Get A Properties ListIntegration name: APALEO_GET_A_PROPERTIES_LIST
Get the list of properties. You need to be authorized (no particular scope required)
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
expand
array
—
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
status
array
—
Filter result by property status
pageSize
integer
—
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
pageNumber
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.
countryCode
array
—
Filter result by country code
includeArchived
boolean
—
Include archived properties in the result. If not set, or set to false, it only returns non-archived properties
Apaleo Get A Property
Apaleo Get A PropertyIntegration name: APALEO_GET_A_PROPERTY
Get a property by id. You need to be authorized (no particular scope required)
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the property.
expand
array
—
List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.
languages
array
—
"all" or comma separated list of two-letter language codes (ISO Alpha-2)
Apaleo Get A Unit
Apaleo Get A UnitIntegration name: APALEO_GET_A_UNIT
Get a unit by id. You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit.
expand
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.
languages
array
—
"all" or comma separated list of two-letter language codes (ISO Alpha-2)
Apaleo Get A Unit Group
Apaleo Get A Unit GroupIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit group.
expand
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.
languages
array
—
"all" or comma separated list of two-letter language codes (ISO Alpha-2)
Apaleo Get A Units List
Apaleo Get A Units ListIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
expand
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.
pageSize
integer
—
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
condition
string
—
Return units with a specific condition
isOccupied
boolean
—
Return only occupied or vacant units
pageNumber
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.
propertyId
string
—
Return units for specific property
textSearch
string
—
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
unitGroupId
string
—
Return units for the specific unit group - DEPRECATED: This property will be removed 20.04.2022. Use UnitGroupIds instead
unitGroupIds
array
—
Return units with the specific unit groups
maintenanceType
string
—
Return units with the specific maintenance type
unitAttributeIds
array
—
Return units with the specific unit attributes
Apaleo Get Unit Attribute By Id
Apaleo Get Unit Attribute By IdIntegration name: APALEO_GET_UNIT_ATTRIBUTE_BY_ID
Get unit attribute by id You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit attribute
Apaleo Get Unit Attribute List
Apaleo Get Unit Attribute ListIntegration name: APALEO_GET_UNIT_ATTRIBUTE_LIST
Get unit attribute list You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
pageSize
integer
—
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
pageNumber
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.
Apaleo List Unit Groups
Apaleo List Unit GroupsIntegration name: APALEO_LIST_UNIT_GROUPS
Get the list of unit groups. You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
expand
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.
pageSize
integer
—
Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.
pageNumber
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.
propertyId
string
—
Return unit groups for specific property
unitGroupTypes
array
—
Unitgrouptypes
Apaleo Move Property To Live
Apaleo Move Property To LiveIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the property
Apaleo Replace A Unit Group
Apaleo Replace A Unit GroupIntegration name: 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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the unit group.
name
object
✅
—
The name for the unit group
rank
integer
—
The unit group rank Restrictions: - Should be greater or equal to one
maxPersons
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.
description
object
✅
—
The description for the unit group
connectedUnitGroups
array
—
The list of connected unit groups this unit group is composed of
Apaleo Reset Property Data
Apaleo Reset Property DataIntegration name: APALEO_RESET_PROPERTY_DATA
This endpoint deletes transactional data for a property in 'Test' status. Requires 'properties.manage' or 'setup.manage' scopes.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
id
string
✅
—
The id of the property
Apaleo Returns A List Of Supported Countries
Apaleo Returns A List Of Supported CountriesIntegration name: 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)
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
No parameters required.
Apaleo Returns Number Of Unit Groups
Apaleo Returns Number Of Unit GroupsIntegration name: APALEO_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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
propertyId
string
—
Return unit groups for specific property
unitGroupTypes
array
—
Unitgrouptypes
Apaleo Returns Number Of Units
Apaleo Returns Number Of UnitsIntegration name: APALEO_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'.
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
condition
string
—
Return units with a specific condition
isOccupied
boolean
—
Return only occupied or vacant units
propertyId
string
—
Return units for specific property
textSearch
string
—
This will filter all units where the provided text is contained in the unit name. The search is case insensitive.
unitGroupId
string
—
Return units for the specific unit group - DEPRECATED: This property will be removed 20.04.2022. Use UnitGroupIds instead
unitGroupIds
array
—
Return units with the specific unit groups
maintenanceType
string
—
Return units with the specific maintenance type
unitAttributeIds
array
—
Return units with the specific unit attributes
Apaleo Return Total Count Of Properties
Apaleo Return Total Count Of PropertiesIntegration name: APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIES
Return total count of properties You need to be authorized (no particular scope required)
Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
No parameters required.