# Apaleo

Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses

- **Category:** scheduling & booking
- **Auth:** OAUTH2
- **Composio Managed App Available?** Yes
- **Tools:** 29
- **Triggers:** 0
- **Slug:** `APALEO`
- **Version:** 20260211_00

## Tools

### Archive a property

**Slug:** `APALEO_ARCHIVE_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: 'properties.manage, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the property |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check if a property exists

**Slug:** `APALEO_CHECK_IF_A_PROPERTY_EXISTS`

Check if a property exists by id.<br>You need to be authorized (no particular scope required)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the property. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check if a unit attribute exists

**Slug:** `APALEO_CHECK_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit attribute. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check if a unit exists

**Slug:** `APALEO_CHECK_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Check if a unit group exists

**Slug:** `APALEO_CHECK_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clones a property

**Slug:** `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.<br>You must have at least one of these scopes: 'properties.create, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the property. |
| `code` | string | Yes | The code for the property that can be shown in reports and table views |
| `name` | object | Yes | The name for the property |
| `taxId` | string | Yes | The Tax-ID of the company running the property, as it should appear on invoices  |
| `timeZone` | string | Yes | 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 | Yes | The legal name of the company running the property. |
| `description` | object | No | The description for the property |
| `currencyCode` | string | Yes | The currency a property works with. |
| `paymentTerms` | object | Yes | The payment terms used for all rate plans |
| `location__city` | string | No | City |
| `bankAccount__bic` | string | No | Bic |
| `bankAccount__bank` | string | No | Bank |
| `bankAccount__iban` | string | No | Iban |
| `managingDirectors` | string | No | The managing director(s) of the company, as they should appear on invoices  |
| `defaultCheckInTime` | string | Yes | The default check-in time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>  |
| `defaultCheckOutTime` | string | Yes | The default check-out time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>  |
| `location__postalCode` | string | No | Postalcode |
| `location__regionCode` | string | No | The ISO 3166-2 code |
| `location__countryCode` | string | No | The country code, in ISO 3166-1 alpha-2 code |
| `location__addressLine1` | string | No | Addressline1 |
| `location__addressLine2` | string | No | Addressline2 |
| `commercialRegisterEntry` | string | Yes | The entry in the Commercial Reigster of the company running the property, as it should appear on invoices  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a unit

**Slug:** `APALEO_CREATE_A_UNIT`

Use this call to create a new unit.<br>You must have at least one of these scopes: 'units.create, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name for the unit |
| `condition` | string ("Clean" | "CleanToBeInspected" | "Dirty") | No | Condition of the unit |
| `attributes` | array | No | Collection of user defined attributes of unit |
| `maxPersons` | integer | Yes | Maximum number of persons for the unit |
| `propertyId` | string | Yes | The id of the property where the unit will be created |
| `description` | object | Yes | The description for the unit |
| `unitGroupId` | string | No | The id of the unit group |
| `connectedUnits` | array | No | The list of units this unit is composed of |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a unit attribute

**Slug:** `APALEO_CREATE_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the unit attribute |
| `description` | string | No | The description of the unit attribute |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a unit group

**Slug:** `APALEO_CREATE_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'.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create multiple units

**Slug:** `APALEO_CREATE_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `units` | array | Yes | Units |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Creates a property

**Slug:** `APALEO_CREATES_A_PROPERTY`

Use this call to create a new property.<br>You must have at least one of these scopes: 'properties.create, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | The code for the property that can be shown in reports and table views |
| `name` | object | Yes | The name for the property |
| `taxId` | string | Yes | The Tax-ID of the company running the property, as it should appear on invoices  |
| `timeZone` | string | Yes | 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 | Yes | The legal name of the company running the property. |
| `description` | object | No | The description for the property |
| `currencyCode` | string | Yes | The currency a property works with. |
| `paymentTerms` | object | Yes | The payment terms used for all rate plans |
| `location__city` | string | No | City |
| `bankAccount__bic` | string | No | Bic |
| `bankAccount__bank` | string | No | Bank |
| `bankAccount__iban` | string | No | Iban |
| `managingDirectors` | string | No | The managing director(s) of the company, as they should appear on invoices  |
| `defaultCheckInTime` | string | Yes | The default check-in time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>  |
| `defaultCheckOutTime` | string | Yes | The default check-out time<br />A time (without fractional second part) as defined in the <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>  |
| `location__postalCode` | string | No | Postalcode |
| `location__regionCode` | string | No | The ISO 3166-2 code |
| `location__countryCode` | string | No | The country code, in ISO 3166-1 alpha-2 code |
| `location__addressLine1` | string | No | Addressline1 |
| `location__addressLine2` | string | No | Addressline2 |
| `commercialRegisterEntry` | string | Yes | The entry in the Commercial Reigster of the company running the property, as it should appear on invoices  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a unit

**Slug:** `APALEO_DELETE_A_UNIT`

Use this call to delete a unit.<br>You must have at least one of these scopes: 'units.delete, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a unit group

**Slug:** `APALEO_DELETE_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Deletes unit attribute

**Slug:** `APALEO_DELETES_UNIT_ATTRIBUTE`

Deletes unit attribute<br>You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Id of unit attribute |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a properties list

**Slug:** `APALEO_GET_A_PROPERTIES_LIST`

Get the list of properties.<br>You need to be authorized (no particular scope required)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | 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 | No | Filter result by property status |
| `pageSize` | integer | No | Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.  |
| `pageNumber` | integer | No | 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 | No | Filter result by country code |
| `includeArchived` | boolean | No | Include archived properties in the result. If not set, or set to false, it only returns non-archived properties  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a property

**Slug:** `APALEO_GET_A_PROPERTY`

Get a property by id.<br>You need to be authorized (no particular scope required)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the property. |
| `expand` | array | No | 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 | No | "all" or comma separated list of two-letter language codes (ISO Alpha-2) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a unit

**Slug:** `APALEO_GET_A_UNIT`

Get a unit by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit. |
| `expand` | array | No | 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 | No | "all" or comma separated list of two-letter language codes (ISO Alpha-2) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a unit group

**Slug:** `APALEO_GET_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit group. |
| `expand` | array | No | 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 | No | "all" or comma separated list of two-letter language codes (ISO Alpha-2) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a units list

**Slug:** `APALEO_GET_A_UNITS_LIST`

Get the list of units.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | 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 | No | Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.  |
| `condition` | string ("Clean" | "CleanToBeInspected" | "Dirty") | No | Return units with a specific condition |
| `isOccupied` | boolean | No | Return only occupied or vacant units |
| `pageNumber` | integer | No | 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 | No | Return units for specific property |
| `textSearch` | string | No | This will filter all units where the provided text is contained in the unit name. The search is case insensitive.  |
| `unitGroupId` | string | No | Return units for the specific unit group - <b>DEPRECATED: This property will be removed 20.04.2022. Use `UnitGroupIds` instead</b>  |
| `unitGroupIds` | array | No | Return units with the specific unit groups |
| `maintenanceType` | string ("OutOfService" | "OutOfOrder" | "OutOfInventory") | No | Return units with the specific maintenance type |
| `unitAttributeIds` | array | No | Return units with the specific unit attributes |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get unit attribute by id

**Slug:** `APALEO_GET_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit attribute |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get unit attribute list

**Slug:** `APALEO_GET_UNIT_ATTRIBUTE_LIST`

Get unit attribute list<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pageSize` | integer | No | Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.  |
| `pageNumber` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Unit Groups

**Slug:** `APALEO_LIST_UNIT_GROUPS`

Get the list of unit groups.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `expand` | array | No | 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 | No | Page size. If this is not set or not positive, the pageNumber is ignored and all items are returned.  |
| `pageNumber` | integer | No | 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 | No | Return unit groups for specific property |
| `unitGroupTypes` | array | No | Unitgrouptypes |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Move property to live

**Slug:** `APALEO_MOVE_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: 'properties.manage, setup.manage'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the property |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace a unit group

**Slug:** `APALEO_REPLACE_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the unit group. |
| `name` | object | Yes | The name for the unit group |
| `rank` | integer | No | The unit group rank Restrictions: - Should be greater or equal to one |
| `maxPersons` | integer | No | 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 | Yes | The description for the unit group |
| `connectedUnitGroups` | array | No | The list of connected unit groups this unit group is composed of |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reset Property Data

**Slug:** `APALEO_RESET_PROPERTY_DATA`

This endpoint deletes transactional data for a property in 'Test' status. Requires 'properties.manage' or 'setup.manage' scopes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The id of the property |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Returns a list of supported countries

**Slug:** `APALEO_RETURNS_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)

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Returns number of unit groups

**Slug:** `APALEO_RETURNS_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'.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `propertyId` | string | No | Return unit groups for specific property |
| `unitGroupTypes` | array | No | Unitgrouptypes |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Returns number of units

**Slug:** `APALEO_RETURNS_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'.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Return total count of properties

**Slug:** `APALEO_RETURN_TOTAL_COUNT_OF_PROPERTIES`

Return total count of properties<br>You need to be authorized (no particular scope required)

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |