> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/apaleo.md).

# Apaleo

Create and amend reservations, check unit availability, and set up rate plans for a property on apaleo.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Apaleo    | Credentials    |

#### Apaleo

Connect to apaleo with a custom app's Client ID and Client Secret (Apps > Connected apps > Add a new app > Add custom app in the apaleo dashboard). Grant the app reservations.create, reservations.read, reservations.manage, availability.read, rateplans.create.

**Set up in Apaleo**

1. Prepare the Apaleo account or service that the workflow will access. Grant access to the required resources and operations.
2. **Client ID:** The Client ID from your apaleo custom app (Apps > Connected apps in the apaleo dashboard).
3. **Client Secret:** The Client Secret shown when the apaleo custom app's secret was created.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Apaleo**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                                   |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Client ID     | Yes      | The Client ID from your apaleo custom app (Apps > Connected apps in the apaleo dashboard). [Provider instructions](https://apaleo.dev/guides/oauth-connection/register-simple-client-app.html). |
| Client Secret | Yes      | The Client Secret shown when the apaleo custom app's secret was created. [Provider instructions](https://apaleo.dev/guides/oauth-connection/register-simple-client-app.html).                   |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Apaleo** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Reservation

Book a single room for a guest at a property, for the given dates and rate plan.

**Required permissions:** `reservations.create`.

**Inputs**

| Field            | Type            | Required | Description                                                                                                                                                                                    |
| ---------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Rate plan        | string          | Yes      | The rate plan (room type and price rules) to book. This also determines which property is booked; look it up in the apaleo dashboard's Rate Plans, or use the id returned by Create Rate Plan. |
| Arrival date     | date            | Yes      | Check-in date.                                                                                                                                                                                 |
| Departure date   | date            | Yes      | Check-out date. Must be after the arrival date.                                                                                                                                                |
| Adults           | integer         | Yes      | Number of adult guests. Default: 1.                                                                                                                                                            |
| Children ages    | string          | No       | Ages of any children staying, separated by commas.                                                                                                                                             |
| Guest first name | string          | Yes      | First name of the primary guest, who is also treated as the booker.                                                                                                                            |
| Guest last name  | string          | Yes      | Last name of the primary guest.                                                                                                                                                                |
| Guest email      | string          | No       | Email address for booking confirmations.                                                                                                                                                       |
| Guest phone      | string          | No       | Phone number for the primary guest.                                                                                                                                                            |
| Booking channel  | select (string) | No       | The sales channel this booking is attributed to. Available values: Direct, BookingCom, Ibe, ChannelManager, Expedia, Hrs, AltoVita, DesVu, Gimsi. Default: Direct.                             |
| Channel source   | string          | No       | Required when the booking channel is ChannelManager: identifies the source system that sent the booking. Leave blank for every other channel.                                                  |
| Guarantee type   | select (string) | No       | How the reservation is guaranteed against no-shows. Available values: PM6Hold, CreditCard, Prepayment, Company.                                                                                |
| Comment          | textarea        | No       | Internal note about the booking.                                                                                                                                                               |

**Outputs**

| Field          | Type   | Description                                                                         |
| -------------- | ------ | ----------------------------------------------------------------------------------- |
| Booking ID     | string | The id of the created booking.                                                      |
| Reservation ID | string | The id of the created reservation, used for check-in, check-out, cancel, and amend. |

#### List Reservations

Search reservations at a property by date range and status.

**Required permissions:** `reservations.read`.

**Inputs**

| Field           | Type            | Required | Description                                                                                                                                                                            |
| --------------- | --------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Property        | string          | No       | Limit results to one property. Leave blank to search across all properties the connection can access.                                                                                  |
| Filter dates by | select (string) | No       | Which date on the reservation the from/to range applies to. Available values: Arrival, Departure, Stay, Creation, Modification, Cancellation, ArrivalAndCheckIn, DepartureAndCheckOut. |
| From date       | date            | No       | Start of the date range to search (inclusive).                                                                                                                                         |
| To date         | date            | No       | End of the date range to search (exclusive: matches strictly before this date, per apaleo's own filter semantics).                                                                     |
| Status          | string          | No       | Only return reservations in these statuses, separated by commas.                                                                                                                       |
| Guest search    | string          | No       | Free-text search across guest name and booking references.                                                                                                                             |
| Page number     | integer         | No       | Which page of results to fetch, starting at 1. Default: 1.                                                                                                                             |
| Page size       | integer         | No       | How many reservations to return per page (max 200). Default: 20.                                                                                                                       |

**Outputs**

| Field          | Type          | Description                                                          |
| -------------- | ------------- | -------------------------------------------------------------------- |
| Total matching | integer       | Total number of reservations matching the filters, across all pages. |
| Reservations   | object\_array | The reservations on this page, with guest, dates, and status.        |
| Next page      | integer       | The page number to request next, if there are more results.          |

#### Amend Reservation

Change the stay dates or number of guests on an existing reservation.

**Required permissions:** `reservations.manage`.

**Inputs**

| Field                      | Type    | Required | Description                                                                                                                                                                                |
| -------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Reservation ID             | string  | Yes      | The reservation to amend.                                                                                                                                                                  |
| New arrival date           | date    | Yes      | The new check-in date.                                                                                                                                                                     |
| New departure date         | date    | Yes      | The new check-out date.                                                                                                                                                                    |
| Adults                     | integer | Yes      | Updated number of adult guests.                                                                                                                                                            |
| Children ages              | string  | No       | Updated ages of any children staying, separated by commas. Leave blank to keep the reservation's current children unchanged; to remove all children, this field cannot express that today. |
| Rate plan                  | string  | Yes      | Rate plan to apply for the amended stay. Use the reservation's current rate plan to keep it unchanged.                                                                                     |
| Re-quote at current prices | boolean | No       | Whether to re-price unchanged time slices at apaleo's current rates. When off, only the parts of the stay that actually changed are re-priced. Default: true.                              |

**Outputs**

| Field          | Type   | Description                     |
| -------------- | ------ | ------------------------------- |
| Reservation ID | string | The amended reservation.        |
| Arrival        | date   | Arrival date after amendment.   |
| Departure      | date   | Departure date after amendment. |

#### Check Unit Availability

List which physical units (rooms) are free at a property for a date range, optionally within one room type.

**Required permissions:** `availability.read`.

**Inputs**

| Field                        | Type    | Required | Description                                                                       |
| ---------------------------- | ------- | -------- | --------------------------------------------------------------------------------- |
| Property                     | string  | Yes      | The apaleo property to check.                                                     |
| From date                    | date    | Yes      | Start of the period to check (inclusive).                                         |
| To date                      | date    | Yes      | End of the period to check (exclusive).                                           |
| Room type                    | string  | No       | Limit results to one room type (unit group). Leave blank to check all room types. |
| Include out-of-service units | boolean | No       | Whether to include units currently marked out of service (maintenance).           |
| Page number                  | integer | No       | Which page of results to fetch, starting at 1. Default: 1.                        |
| Page size                    | integer | No       | How many units to return per page. Default: 20.                                   |

**Outputs**

| Field                 | Type          | Description                                                           |
| --------------------- | ------------- | --------------------------------------------------------------------- |
| Total available units | integer       | Total number of units matching the filters, across all pages.         |
| Units                 | object\_array | The available units on this page, with their room type and condition. |
| Next page             | integer       | The page number to request next, if there are more results.           |

#### Create Rate Plan

Set up a new rate plan (room type, price rules, and sales channels) for a property.

**Required permissions:** `rateplans.create`.

**Inputs**

| Field                        | Type            | Required | Description                                                                                                                                                                                    |
| ---------------------------- | --------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Property                     | string          | Yes      | The apaleo property this rate plan belongs to.                                                                                                                                                 |
| Rate plan code               | string          | Yes      | A short unique code identifying this rate plan within the property.                                                                                                                            |
| Name                         | string          | Yes      | Display name shown to guests and staff. Used for every mandatory language on the apaleo account (English and German); this integration does not support per-language translations.             |
| Description                  | string          | No       | Longer description shown to guests. Defaults to the name if left blank. Used for every mandatory language on the apaleo account (English and German).                                          |
| Room type                    | string          | Yes      | The room type (unit group) this rate plan sells, from the apaleo dashboard.                                                                                                                    |
| Cancellation policy          | string          | Yes      | The cancellation policy to attach, already configured in the apaleo dashboard.                                                                                                                 |
| Stay length definition       | string          | Yes      | Which stay-length definition (e.g. overnight) this rate plan uses, from the apaleo dashboard.                                                                                                  |
| No-show policy               | string          | No       | The no-show policy to attach, if the property uses one.                                                                                                                                        |
| Sales channels               | string          | No       | Which sales channels this rate plan is sold through, separated by commas. Default: Direct.                                                                                                     |
| Minimum guarantee type       | select (string) | Yes      | The minimum guarantee guests must provide to book this rate plan. Available values: PM6Hold, CreditCard, Prepayment, Company.                                                                  |
| VAT type                     | select (string) | Yes      | The VAT rate applied to this rate plan's accounting entries. Available values: Null, VeryReduced, Reduced, Normal, Without, Special, Special1, Special2, ReducedCovid19, NormalCovid19, Mixed. |
| Accounting service type      | select (string) | Yes      | Which kind of service this rate plan's revenue is booked against. Available values: Other, Accommodation, FoodAndBeverages.                                                                    |
| Accounting config valid from | string          | No       | The date this VAT/service-type configuration starts applying. Leave blank to apply it from the beginning (1970-01-01).                                                                         |
| Sub-account                  | string          | No       | The finance sub-account to post this rate plan's revenue to, if the property uses one.                                                                                                         |

**Outputs**

| Field          | Type   | Description                            |
| -------------- | ------ | -------------------------------------- |
| Rate plan ID   | string | The id of the newly created rate plan. |
| Rate plan code | string | Echoes the rate plan code.             |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/apaleo.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
