Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Apaleo

Scalekit connector
Open markdown

The Apaleo connector lets your AI agent act in each user's Apaleo account. Each user signs in to Apaleo once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 92 tools.

Tools
92
What they doRead · write · destructive
55 · 33 · 455 read33 write4 destructive
Users sign in with
OAuth app
Your own Apaleo app

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Apaleo connection

    In AgentKit > Connections, create an Apaleo connection and copy its redirect URI. The name you give it is the connection_name your code passes. See Configure connections.

  4. Register an OAuth app

    Apaleo connections use your own OAuth app. Register one with Apaleo and add the redirect URI you copied.

    Then enter the app's Client ID and Client Secret on the Apaleo connection.

  5. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'apaleo'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Apaleo:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'apaleo_count_properties',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user signs in once. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • apaleo_count_propertiesCount the properties in the account.Read-only

    Count Properties

    Count the properties in the account. Returns an object with `count`. Use when only the number of properties matters. Use list_properties for the records.

    Inputs

    This tool takes no inputs.

  • apaleo_count_reservationsCount reservations matching the filters.Read-only

    Count Reservations

    Count reservations matching the filters. Returns an object with `count`. Use when only the total matters.

    Inputs

    allFoliosHaveInvoiceboolean
    If set to `true`, returns only reservations, in which all folios are closed and have an invoice. If set to `false`, returns only reservations, in which some of the folios are open or don't have an invoice
    balanceFilterstring
    This will filter reservations based on their balance. You can provide an array of string expressions which all need to apply. Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be: 'eq' for equals 'neq' for not equals 'lt' for less than 'gt' for greater than 'lte' for less than or equals 'gte' for greater than or equals For instance 'eq_5' would mean the value should equal 5 'lte_7' would mean... Comma-separated list.
    blockIdsstring
    Filter result by requested blocks Comma-separated list.
    bookingIdstring
    Filter result by booking id
    channelCodestring
    Filter result by the channel code Comma-separated list of: Direct, BookingCom, Ibe, ChannelManager, Expedia, Homelike, Hrs, AltoVita, DesVu, Gimsi.
    companyIdsstring
    Filter result by requested companies Comma-separated list.
    dateFilterstring
    Filter by date and time attributes of reservation. Use in combination with the 'To' and 'From' attributes. All filters will check if the date specified by the filter type is between from (included) and to (excluded). The exception being filtering for 'stay', which will return all reservations that are overlapping with the interval specified by from and to.one of ArrivalDepartureStayCreationModificationCancellationArrivalAndCheckInDepartureAndCheckOut
    externalCodestring
    Filter result by the external code. The result set will contain all reservations that have an external code starting with the provided value
    externalReferencesstring
    This will filter all reservation where the provided external references have an exact match on at least one of the properties in Apaleo.Api.Modules.Booking.Models.Reservation.ExternalReferencesModel Comma-separated list.
    fromstring
    The start of the time interval. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
    hasActivePaymentAccountboolean
    If set to `true`, returns only the reservations with an active payment account. If set to `false`, returns only the reservations without an active payment account.
    isPreCheckedInboolean
    If set to `true`, returns only the reservations marked as pre-checked-in. If set to `false`, returns only the reservations not marked as pre-checked-in.
    marketSegmentIdsstring
    Filter result by requested market segments Comma-separated list.
    propertyIdsstring
    Filter result by requested properties Comma-separated list.
    ratePlanIdsstring
    Filter result by requested rate plans Comma-separated list.
    sourcesstring
    Filter result by source Comma-separated list.
    statusstring
    Filter result by reservation status Comma-separated list of: Confirmed, InHouse, CheckedOut, Canceled, NoShow.
    textSearchstring
    Filters reservations by searching for the provided text across multiple fields. The search is case-insensitive and includes: - Booker information (first name, last name, email, company name) - Primary guest information (first name, last name, email, company name) - Additional guest information (first name, last name, email, company name) - Reservation details (external code, external references, reservation ID) - Unit name - Group name
    tostring
    The end of the time interval, must be larger than 'from'. When filtering by date, at least one of 'from' and 'to' has to be specified A date and time (without fractional second part) in UTC or with UTC offset as defined in ISO8601:2004
    unitGroupIdsstring
    Filter result by requested unit groups Comma-separated list.
    unitGroupTypesstring
    Filter result by requested unit group types Comma-separated list of: BedRoom, MeetingRoom, EventSpace, ParkingLot, Other.
    unitIdsstring
    Filter result by assigned units Comma-separated list.
    validationMessageCategorystring
    Filter result by validation message category Comma-separated list of: OfferNotAvailable, AutoUnitAssignment, GuestLoyalty.
  • apaleo_get_arrivals_reportGet the arrivals and departures report for a property over a date range.Read-only

    Get Arrivals Report

    Get the arrivals and departures report for a property over a date range. Returns an object with `total`, `totalAdults`, `totalChildren`, `travelPurposeBreakdown`, `nationalityBreakdown`, `countryOfResidenceBreakdown`. Use for front-desk planning.

    Inputs

    monthintegerrequired
    Requested month for the report.
    propertyIdstringrequired
    Requested property.
    yearintegerrequired
    Requested year for the report.
  • apaleo_get_blockGet one room block by its id.Read-only

    Get Block

    Get one room block by its id. Returns an object with `id`, `group`, `status`, `property`, `ratePlan`, `unitGroup`, `grossDailyRate` and more. Use after list_blocks for details.

    Inputs

    blockIdstringrequired
    Id of the block to be retrieved.
    expandstring
    List of all embedded resources that should be expanded in the response. Possible values are: actions, timeSlices. All other values will be silently ignored. Comma-separated list of: actions, timeSlices.
  • apaleo_get_bookingGet one booking, including its booker and reservations.Read-only

    Get Booking

    Get one booking, including its booker and reservations. Returns an object with `id`, `groupId`, `booker`, `paymentAccount`, `hasActivePaymentAccount`, `registeredCard`, `comment` and more. Use after list_bookings for the full booking.

    Inputs

    bookingIdstringrequired
    Id of the booking to be retrieved.
    expandstring
    List of all embedded resources that should be expanded in the response. Possible values are: property, unitGroup, ratePlan, services, reservations, propertyValues. All other values will be silently ignored. Comma-separated list of: property, unitGroup, ratePlan, services, reservations, propertyValues.
  • apaleo_get_companyGet one company by its id.Read-only

    Get Company

    Get one company by its id. Returns an object with `id`, `code`, `propertyId`, `name`, `invoicingEmail`, `phone`, `taxId` and more. Use after list_companies for a single company's details.

    Inputs

    companyIdstringrequired
    The ID of the company.
  • apaleo_get_current_accountGet the Apaleo account the connected user belongs to.Read-only

    Get Current Account

    Get the Apaleo account the connected user belongs to. Returns an object with `code`, `name`, `description`, `defaultLanguage`, `logoUrl`, `location`, `type` and more. Use first to confirm which account is connected.

    Inputs

    This tool takes no inputs.

  • apaleo_get_folioGet one folio with its charges, payments and balance.Read-only

    Get Folio

    Get one folio with its charges, payments and balance. Returns an object with `id`, `created`, `updated`, `type`, `debitor`, `closingDate`, `reservation` and more. Use after list_folios for the full bill.

    Inputs

    folioIdstringrequired
    The ID of the folio.
    expandstring
    List of all embedded resources that should be expanded in the response. Possible values are: folios. All other values will be silently ignored. Comma-separated list of: folios.