29 available actions
What your AI agent can do in Apaleo
Apaleo is a cloud-based property management platform handling reservations, billing, and daily operations for hospitality businesses This page lists every available action. Your agent only receives the actions and permissions required for the role you approve.
Showing all 29 actions.
Common starting points
- Check if a property existsCheck if a property exists by id.<br>You need to be authorized (no particular scope required)
- Check if a unit attribute existsCheck if a unit attribute exists<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
- Create a unitUse this call to create a new unit.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
- Create a unit attributeUse this call to create a new unit attribute.<br>You must have at least one of these scopes: 'unitattributes.create, setup.manage'.
- Archive a propertyUse 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…
- Move property to liveUse 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…
Browse all 29 actions by capability
Open a capability to see every supported action and its description.
Find & reviewLook up and review existing recordsView 12 actions
- Check if a property existsCheck if a property exists by id.<br>You need to be authorized (no particular scope required)
- Check if a unit attribute existsCheck if a unit attribute exists<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
- Check if a unit existsCheck if a unit exists by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
- Check if a unit group existsCheck if a unit group exists by id.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
- Get a properties listGet the list of properties.<br>You need to be authorized (no particular scope required)
- Get a propertyGet a property by id.<br>You need to be authorized (no particular scope required)
- Get a unitGet a unit by id.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
- Get a unit groupGet a unit group by id.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
- Get a units listGet the list of units.<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
- Get unit attribute by idGet unit attribute by id<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
- Get unit attribute listGet unit attribute list<br>You must have at least one of these scopes: 'unitattributes.read, setup.read, setup.manage'.
- List Unit GroupsGet the list of unit groups.<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
Create & communicateCreate records or send supported messagesView 4 actions
- Create a unitUse this call to create a new unit.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
- Create a unit attributeUse this call to create a new unit attribute.<br>You must have at least one of these scopes: 'unitattributes.create, setup.manage'.
- Create a unit groupUse this call to create a new unit group.<br>You must have at least one of these scopes: 'unitgroups.create, setup.manage'.
- Create multiple unitsUse this call to create multiple units, following a naming rule.<br>You must have at least one of these scopes: 'units.create, setup.manage'.
Update & manageChange and manage existing recordsView 3 actions
- Archive a propertyUse 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…
- Move property to liveUse 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…
- Replace a unit groupUse this call to modify a unit group.<br>You must have at least one of these scopes: 'unitgroups.manage, setup.manage'.
Remove & cancelRemove records or cancel supported workView 2 actions
- Delete a unitUse this call to delete a unit.<br>You must have at least one of these scopes: 'units.delete, setup.manage'.
- Delete a unit groupUse this call to delete a unit group.<br>You must have at least one of these scopes: 'unitgroups.delete, setup.manage'.
Other actionsSpecialist and administrative actions.View 8 actions
- Clones a propertyUse this call to clone a specific property.
- Creates a propertyUse this call to create a new property.<br>You must have at least one of these scopes: 'properties.create, setup.manage'.
- Deletes unit attributeDeletes unit attribute<br>You must have at least one of these scopes: 'unitattributes.delete, setup.manage'.
- Reset Property DataThis endpoint deletes transactional data for a property in 'Test' status.
- Returns a list of supported countriesReturns a list of ISO country codes that could be used to create properties.<br>You need to be authorized (no particular scope required)
- Returns number of unit groupsReturns number of unit groups matching the filter criteria<br>You must have at least one of these scopes: 'unitgroups.read, setup.read, setup.manage'.
- Returns number of unitsReturns number of units matching the filter criteria<br>You must have at least one of these scopes: 'units.read, setup.read, setup.manage'.
- Return total count of propertiesReturn total count of properties<br>You need to be authorized (no particular scope required)
Connection record
A connection you can control.
- Sign-in
- OAuth sign-in
- Setup
- Sign in with your own Apaleo account. Access is limited to the work agreed for the role.
- Boundaries
- Only the approved role and actions.
- Off switch
- Revoke the connection from your account.
FAQ
Before you connect Apaleo
How does the agent connect to Apaleo?
You sign in with your own Apaleo account. Permissions are limited to what the agent needs, the connection is health-checked, and you can revoke access from Apaleo at any time.
What can the agent actually do in Apaleo?
The page above lists the 29 actions currently available through the Apaleo connection. The role determines which of those actions the agent may use, and write access is only enabled when the workflow needs it.
Is Apaleo included in my plan?
Connections are priced per tool on top of the base plan. Some are included and some are premium. See pricing for how connection charges work.
How long until Apaleo is ready?
Timing depends on the sign-in method, permissions and workflow being connected. We confirm the scope and setup plan before enabling the connection.
Bring the workflow together
Ready to put Apaleo to work?
Start with the responsibility you want off your plate. We’ll map the connection and the boundaries around it.