# 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](https://toolhouse.app/auth-connections?authkit_slugs=apaleo). ## Tools (29) ### `Apaleo Archive A Property` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ---------------------- | | `id` | string | ✅ | — | The id of the property | *** ### `Apaleo Check If A Property Exists` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ----------------------- | | `id` | string | ✅ | — | The id of the property. | *** ### `Apaleo Check If A Unit Attribute Exists` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ----------------------------- | | `id` | string | ✅ | — | The id of the unit attribute. | *** ### `Apaleo Check If A Unit Exists` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ------------------- | | `id` | string | ✅ | — | The id of the unit. | *** ### `Apaleo Check If A Unit Group Exists` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ------------------------- | | `id` | string | ✅ | — | The id of the unit group. | *** ### `Apaleo Clones A Property` Integration 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. | Parameter | Type | Required | Example | Description | | ------------------------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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: ) | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ---------------- | ------- | :------: | ------- | ----------------------------------------------------- | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ------------- | ------ | :------: | ------- | ------------------------------------- | | `name` | string | ✅ | — | The name of the unit attribute | | `description` | string | | — | The description of the unit attribute | *** ### `Apaleo Create A Unit Group` Integration 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. | Parameter | Type | Required | Example | Description | | --------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------ | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ----- | :------: | ------- | ----------- | | `units` | array | ✅ | — | Units | *** ### `Apaleo Creates A Property` Integration 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. | Parameter | Type | Required | Example | Description | | ------------------------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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: ) | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ------------------- | | `id` | string | ✅ | — | The id of the unit. | *** ### `Apaleo Delete A Unit Group` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ------------------------- | | `id` | string | ✅ | — | The id of the unit group. | *** ### `Apaleo Deletes Unit Attribute` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | -------------------- | | `id` | string | ✅ | — | Id of unit attribute | *** ### `Apaleo Get A Properties List` Integration 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. | Parameter | Type | Required | Example | Description | | ----------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ----------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ------------------ | ------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ---------------------------- | | `id` | string | ✅ | — | The id of the unit attribute | *** ### `Apaleo Get Unit Attribute List` Integration 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. | Parameter | Type | Required | Example | Description | | ------------ | ------- | :------: | ------- | --------------------------------------------------------------------------------------------------------------------------------- | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | ---------------- | ------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ---------------------- | | `id` | string | ✅ | — | The id of the property | *** ### `Apaleo Replace A Unit Group` Integration 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. | Parameter | Type | Required | Example | Description | | --------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `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` Integration 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. | Parameter | Type | Required | Example | Description | | --------- | ------ | :------: | ------- | ---------------------- | | `id` | string | ✅ | — | The id of the property | *** ### `Apaleo Returns A List Of Supported Countries` Integration 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` Integration 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. | Parameter | Type | Required | Example | Description | | ---------------- | ------ | :------: | ------- | ---------------------------------------- | | `propertyId` | string | | — | Return unit groups for specific property | | `unitGroupTypes` | array | | — | Unitgrouptypes | *** ### `Apaleo Returns Number Of Units` Integration 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. | Parameter | Type | Required | Example | Description | | ------------------ | ------- | :------: | ------- | --------------------------------------------------------------------------------------------------------------------------- | | `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` Integration 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.* --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.toolhouse.ai/toolhouse/integrations/apaleo.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.