apaleo
apaleo is an API-first cloud hotel property-management system (PMS) and platform. Every capability - reservations, bookings, blocks, inventory, rate plans, availability, and finance - is exposed through documented REST APIs secured with OAuth 2.0, published as OpenAPI, with webhooks for real-time events, enabling an open marketplace of integrations.
APIs
apaleo Booking API
End-to-end reservation lifecycle - create bookings and reservations, fetch offers, manage groups and blocks, and run reservation actions such as check-in, check-out, amend, assi...
apaleo Inventory API
Manage the physical inventory of properties, units, unit groups, and unit attributes - including property rollout actions such as clone, archive, and set-live.
apaleo Rate Plan API
Set up and update rate plans, rates, services, companies, and cancellation / no-show policies in real time, plus corporate and promo code lookups.
apaleo Availability API
Query real-time availability for units, unit groups, services, and properties, and adjust per-unit-group availability.
apaleo Finance API
Folios, charges, payments, refunds, invoices, routings, and the chart of accounts - covering the full accounting and ledger surface of the platform.
apaleo Settings API
Account- and property-level configuration - city tax, capture policies, market segments, languages, sub-accounts, features, and time-slice definitions.
apaleo Webhook API
Create and manage webhook subscriptions for real-time events across topics such as Reservation, Folio, Invoice, RatePlan, Block, Unit, and Property, with per-topic event filters...
Collections
apaleo Platform API
OPENPricing Plans
Rate Limits
FinOps
Apaleo Finops
FINOPSResources
Sources
opencollection: 1.0.0
info:
name: apaleo Platform API
version: v1
request:
auth:
type: bearer
token: '{{bearerToken}}'
items:
- info:
name: Booking
type: folder
items:
- info:
name: Creates a link to a payment form that allows guests to complete the authorization
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/authorizations/by-link
docs: Creates a link to a payment form that allows guests to complete the authorization
- info:
name: Creates the authorization by using the terminal
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/authorizations/by-terminal
docs: Creates the authorization by using the terminal
- info:
name: Creates authorization by using a previously created payment account
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/authorizations/by-payment-account
docs: Creates authorization by using a previously created payment account
- info:
name: Creates the authorization based on an existing pre-authorization created prior directly with the payment service
provider
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/authorizations/by-authorization
docs: Creates the authorization based on an existing pre-authorization created prior directly with the payment service
provider
- info:
name: Returns a single authorization by ID
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/authorizations/{id}
docs: Returns a single authorization by ID
- info:
name: Returns a list of authorizations based on the query parameters
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/authorizations
docs: Returns a list of authorizations based on the query parameters
- info:
name: Cancels the authorization
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/authorization-actions/{authorizationId}/cancel
docs: Cancels the authorization
- info:
name: Updates the requested amount and extends the expiry date of the authorization
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/authorization-actions/{authorizationId}/refresh
docs: Updates the requested amount and extends the expiry date of the authorization
- info:
name: Expires the pending payment link with the payment provider and updates the status to Expired
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/authorization-actions/{authorizationId}/expire-payment-link
docs: Expires the pending payment link with the payment provider and updates the status to Expired
- info:
name: Creates a block
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/blocks
docs: Creates a block
- info:
name: Returns a list of blocks
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/blocks
docs: Returns a list of blocks
- info:
name: Returns number of blocks
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/blocks/$count
docs: Returns number of blocks
- info:
name: Returns a specific block.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/blocks/{id}
docs: Returns a specific block.
- info:
name: Delete a specific block
type: http
http:
method: DELETE
url: https://api.apaleo.com/booking/v1/blocks/{id}
docs: Delete a specific block
- info:
name: Confirm a block.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/confirm
docs: Confirm a block.
- info:
name: Set a block to optional.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/set-to-optional
docs: Set a block to optional.
- info:
name: Edit the optional fields of a block.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/set-optional-fields
docs: Edit the optional fields of a block.
- info:
name: Release a block.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/release
docs: Release a block.
- info:
name: Cancel a block.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/cancel
docs: Cancel a block.
- info:
name: Wash a block.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/wash
docs: Wash a block.
- info:
name: Allow to modify a block
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/block-actions/{id}/amend
docs: Allow to modify a block
- info:
name: Creates a booking for one or more reservations.
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/bookings
docs: Creates a booking for one or more reservations.
- info:
name: Returns a list of all bookings, filtered by the specified parameters.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/bookings
docs: Returns a list of all bookings, filtered by the specified parameters.
- info:
name: Creates a booking for one or more reservations regardless of availability or restrictions.
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/bookings/$force
docs: Creates a booking for one or more reservations regardless of availability or restrictions.
- info:
name: Add one or multiple reservations to an existing booking.
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/bookings/{id}/reservations
docs: Add one or multiple reservations to an existing booking.
- info:
name: Add one or multiple reservations to an existing booking regardless of availability or restrictions.
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/bookings/{id}/reservations/$force
docs: Add one or multiple reservations to an existing booking regardless of availability or restrictions.
- info:
name: Returns a specific booking.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/bookings/{id}
docs: Returns a specific booking.
- info:
name: Allows to modify certain booking properties
type: http
http:
method: PATCH
url: https://api.apaleo.com/booking/v1/bookings/{id}
docs: Allows to modify certain booking properties
- info:
name: Creates a group booking.
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/groups
docs: Creates a group booking.
- info:
name: Returns a list of all group bookings, filtered by the specified parameters.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/groups
docs: Returns a list of all group bookings, filtered by the specified parameters.
- info:
name: Returns a specific group booking.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/groups/{id}
docs: Returns a specific group booking.
- info:
name: Allows to modify certain group booking properties
type: http
http:
method: PATCH
url: https://api.apaleo.com/booking/v1/groups/{id}
docs: Allows to modify certain group booking properties
- info:
name: Delete a certain group booking
type: http
http:
method: DELETE
url: https://api.apaleo.com/booking/v1/groups/{id}
docs: Delete a certain group booking
- info:
name: Returns number of group bookings
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/groups/$count
docs: Returns number of group bookings
- info:
name: Add one or multiple reservations to an existing group booking using blocked inventory.
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/groups/{id}/reservations
docs: Add one or multiple reservations to an existing group booking using blocked inventory.
- info:
name: Returns offers for one specific stay.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/offers
docs: Returns offers for one specific stay.
- info:
name: Returns offers for a specific rate plan.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/rate-plan-offers
docs: Returns offers for a specific rate plan.
- info:
name: Returns service offers for one specific stay.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/service-offers
docs: Returns service offers for one specific stay.
- info:
name: Returns offers with rates and availabilities for the specified range.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/offer-index
docs: Returns offers with rates and availabilities for the specified range.
- info:
name: Creates payment account by using the terminal
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/payment-accounts/by-terminal
docs: Creates payment account by using the terminal
- info:
name: Creates a link to a payment form that allows guests to complete the payment account
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/payment-accounts/by-link
docs: Creates a link to a payment form that allows guests to complete the payment account
- info:
name: Creates payment account based on an existing authorization created prior externally with the Payment Service Provider
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/payment-accounts/by-authorization
docs: Creates payment account based on an existing authorization created prior externally with the Payment Service Provider
- info:
name: Creates payment account based on an existing authorization created prior externally with the Payment Service Provider
type: http
http:
method: POST
url: https://api.apaleo.com/booking/v1/payment-accounts/by-stored-payment-method
docs: Creates payment account based on an existing authorization created prior externally with the Payment Service Provider
- info:
name: Returns a single payment account by ID
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/payment-accounts/{id}
docs: Returns a single payment account by ID
- info:
name: Returns a list of payment accounts based on the query parameters
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/payment-accounts
docs: Returns a list of payment accounts based on the query parameters
- info:
name: Sets payment account status to Canceled
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/payment-account-actions/{paymentAccountId}/cancel
docs: Sets payment account status to Canceled
- info:
name: Expires the pending payment link with the payment provider and updates the status to Expired
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/payment-account-actions/{paymentAccountId}/expire-payment-link
docs: Expires the pending payment link with the payment provider and updates the status to Expired
- info:
name: Returns a list of all reservations, filtered by the specified parameters.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/reservations
docs: Returns a list of all reservations, filtered by the specified parameters.
- info:
name: Returns the number of reservations fulfilling the criteria specified in the parameters.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/reservations/$count
docs: Returns the number of reservations fulfilling the criteria specified in the parameters.
- info:
name: Returns a specific reservation.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/reservations/{id}
docs: Returns a specific reservation.
- info:
name: Allows to modify certain reservation properties
type: http
http:
method: PATCH
url: https://api.apaleo.com/booking/v1/reservations/{id}
docs: Allows to modify certain reservation properties
- info:
name: Returns offers for one specific reservation.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/reservations/{id}/offers
docs: Returns offers for one specific reservation.
- info:
name: Returns service offers for one specific reservation.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/reservations/{id}/service-offers
docs: Returns service offers for one specific reservation.
- info:
name: Returns the services booked for a specific reservation.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/reservations/{id}/services
docs: Returns the services booked for a specific reservation.
- info:
name: Removes a service from a reservation.
type: http
http:
method: DELETE
url: https://api.apaleo.com/booking/v1/reservations/{id}/services
docs: Removes a service from a reservation.
- info:
name: Assign a unit to a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/assign-unit
docs: Assign a unit to a reservation.
- info:
name: Assign a specific unit to a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/assign-unit/{unitId}
docs: Assign a specific unit to a reservation.
- info:
name: Unassign units from a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/unassign-units
docs: Unassign units from a reservation.
- info:
name: Check-in of a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/checkin
docs: Check-in of a reservation.
- info:
name: Reverses the check-in of a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/revert-checkin
docs: Reverses the check-in of a reservation.
- info:
name: Check-out of a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/checkout
docs: Check-out of a reservation.
- info:
name: Cancel a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/cancel
docs: Cancel a reservation.
- info:
name: Set a reservation to No-show.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/noshow
docs: Set a reservation to No-show.
- info:
name: Allows you to amend the stay details of a reservation
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/amend
docs: Allows you to amend the stay details of a reservation
- info:
name: Allows you to amend the stay details of a reservation regardless of availability or restrictions.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/amend/$force
docs: Allows you to amend the stay details of a reservation regardless of availability or restrictions.
- info:
name: Book the service for a specific reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/book-service
docs: Book the service for a specific reservation.
- info:
name: Book the service for a specific reservation regardless of availability.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/book-service/$force
docs: Book the service for a specific reservation regardless of availability.
- info:
name: Removes the city tax from a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/remove-city-tax
docs: Removes the city tax from a reservation.
- info:
name: Adds the city tax to a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/add-city-tax
docs: Adds the city tax to a reservation.
- info:
name: Lock unit assignment for a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/lock-unit
docs: Lock unit assignment for a reservation.
- info:
name: Unlock unit assignment for a reservation.
type: http
http:
method: PUT
url: https://api.apaleo.com/booking/v1/reservation-actions/{id}/unlock-unit
docs: Unlock unit assignment for a reservation.
- info:
name: Returns a list of supported sources.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/types/sources
docs: Returns a list of supported sources.
- info:
name: Returns a list of values that a field of the specified type can take in the specified country.
type: http
http:
method: GET
url: https://api.apaleo.com/booking/v1/types/{type}/allowed-values
docs: Returns a list of values that a field of the specified type can take in the specified country.
- info:
name: Inventory
type: folder
items:
- info:
name: Get a properties list
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/properties
docs: Get a properties list
- info:
name: Creates a property
type: http
http:
method: POST
url: https://api.apaleo.com/inventory/v1/properties
docs: Creates a property
- info:
name: Return total count of properties
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/properties/$count
docs: Return total count of properties
- info:
name: Get a property
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/properties/{id}
docs: Get a property
- info:
name: Allows to modify property
type: http
http:
method: PATCH
url: https://api.apaleo.com/inventory/v1/properties/{id}
docs: Allows to modify property
- info:
name: Deletes a property
type: http
http:
method: DELETE
url: https://api.apaleo.com/inventory/v1/properties/{id}
docs: Deletes a property
- info:
name: Clones a property
type: http
http:
method: POST
url: https://api.apaleo.com/inventory/v1/property-actions/{id}/clone
docs: Clones a property
- info:
name: Archive a property
type: http
http:
method: PUT
url: https://api.apaleo.com/inventory/v1/property-actions/{id}/archive
docs: Archive a property
- info:
name: Move property to live
type: http
http:
method: PUT
url: https://api.apaleo.com/inventory/v1/property-actions/{id}/set-live
docs: Move property to live
- info:
name: Reset a test property and delete all transactional data
type: http
http:
method: PUT
url: https://api.apaleo.com/inventory/v1/property-actions/{id}/reset
docs: Reset a test property and delete all transactional data
- info:
name: Returns a list of supported countries.
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/types/countries
docs: Returns a list of supported countries.
- info:
name: Allows to patch unit
type: http
http:
method: PATCH
url: https://api.apaleo.com/inventory/v1/units/{id}
docs: Allows to patch unit
- info:
name: Get a unit
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/units/{id}
docs: Get a unit
- info:
name: Delete a unit
type: http
http:
method: DELETE
url: https://api.apaleo.com/inventory/v1/units/{id}
docs: Delete a unit
- info:
name: Allows to patch one or more units
type: http
http:
method: PATCH
url: https://api.apaleo.com/inventory/v1/units
docs: Allows to patch one or more units
- info:
name: Get a units list
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/units
docs: Get a units list
- info:
name: Create a unit
type: http
http:
method: POST
url: https://api.apaleo.com/inventory/v1/units
docs: Create a unit
- info:
name: Returns number of units
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/units/$count
docs: Returns number of units
- info:
name: Create multiple units
type: http
http:
method: POST
url: https://api.apaleo.com/inventory/v1/units/bulk
docs: Create multiple units
- info:
name: Archive a unit
type: http
http:
method: PUT
url: https://api.apaleo.com/inventory/v1/unit-actions/{id}/archive
docs: Archive a unit
- info:
name: Get unit attribute by id
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/unit-attributes/{id}
docs: Get unit attribute by id
- info:
name: Allows to modify unit attribute
type: http
http:
method: PATCH
url: https://api.apaleo.com/inventory/v1/unit-attributes/{id}
docs: Allows to modify unit attribute
- info:
name: Deletes unit attribute
type: http
http:
method: DELETE
url: https://api.apaleo.com/inventory/v1/unit-attributes/{id}
docs: Deletes unit attribute
- info:
name: Get unit attribute list
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/unit-attributes
docs: Get unit attribute list
- info:
name: Create a unit attribute
type: http
http:
method: POST
url: https://api.apaleo.com/inventory/v1/unit-attributes
docs: Create a unit attribute
- info:
name: Create a unit group
type: http
http:
method: POST
url: https://api.apaleo.com/inventory/v1/unit-groups
docs: Create a unit group
- info:
name: Get all unit groups, or all unit groups for a property
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/unit-groups
docs: Get all unit groups, or all unit groups for a property
- info:
name: Returns number of unit groups
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/unit-groups/$count
docs: Returns number of unit groups
- info:
name: Get a unit group
type: http
http:
method: GET
url: https://api.apaleo.com/inventory/v1/unit-groups/{id}
docs: Get a unit group
- info:
name: Replace a unit group
type: http
http:
method: PUT
url: https://api.apaleo.com/inventory/v1/unit-groups/{id}
docs: Replace a unit group
- info:
name: Delete a unit group
type: http
http:
method: DELETE
url: https://api.apaleo.com/inventory/v1/unit-groups/{id}
docs: Delete a unit group
- info:
name: Rate Plan
type: folder
items:
- info:
name: Create a cancellation policy.
type: http
http:
method: POST
url: https://api.apaleo.com/rateplan/v1/cancellation-policies
docs: Create a cancellation policy.
- info:
name: Get all cancellation policies.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/cancellation-policies
docs: Get all cancellation policies.
- info:
name: Get a specific cancellation policy.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/cancellation-policies/{id}
docs: Get a specific cancellation policy.
- info:
name: Allows to modify properties of a cancellation policy
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/cancellation-policies/{id}
docs: Allows to modify properties of a cancellation policy
- info:
name: Delete a cancellation policy
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/cancellation-policies/{id}
docs: Delete a cancellation policy
- info:
name: Create a company
type: http
http:
method: POST
url: https://api.apaleo.com/rateplan/v1/companies
docs: Create a company
- info:
name: Get a list of companies
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/companies
docs: Get a list of companies
- info:
name: Get a company
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/companies/{id}
docs: Get a company
- info:
name: Modify a company
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/companies/{id}
docs: Modify a company
- info:
name: Delete a company
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/companies/{id}
docs: Delete a company
- info:
name: Returns a list of corporate codes.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/corporate-codes/codes
docs: Returns a list of corporate codes.
- info:
name: Create a no-show policy.
type: http
http:
method: POST
url: https://api.apaleo.com/rateplan/v1/no-show-policies
docs: Create a no-show policy.
- info:
name: Get all no-show policies.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/no-show-policies
docs: Get all no-show policies.
- info:
name: Get a specific no-show policy.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/no-show-policies/{id}
docs: Get a specific no-show policy.
- info:
name: Allows to modify properties of a no-show policy
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/no-show-policies/{id}
docs: Allows to modify properties of a no-show policy
- info:
name: Delete a no-show policy
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/no-show-policies/{id}
docs: Delete a no-show policy
- info:
name: Returns a list of promo codes.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/promo-codes/codes
docs: Returns a list of promo codes.
- info:
name: Returns a list of rates.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}/rates
docs: Returns a list of rates.
- info:
name: Initializes and changes the rates for the rate plan.
type: http
http:
method: PUT
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}/rates
docs: Initializes and changes the rates for the rate plan.
- info:
name: Allows to patch multiple rates of a single rate plan.
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}/rates
docs: Allows to patch multiple rates of a single rate plan.
- info:
name: Deletes the rates for the rate plan
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}/rates
docs: Deletes the rates for the rate plan
- info:
name: Returns the number of rates for a specific rate plan within the specifed time range.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}/rates/$count
docs: Returns the number of rates for a specific rate plan within the specifed time range.
- info:
name: Allows to patch the rates of multiple rate plans.
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/rates
docs: Allows to patch the rates of multiple rate plans.
- info:
name: Get a rate plan list
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/rate-plans
docs: Get a rate plan list
- info:
name: Create a rate plan
type: http
http:
method: POST
url: https://api.apaleo.com/rateplan/v1/rate-plans
docs: Create a rate plan
- info:
name: Allows to patch one or more rate plans
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/rate-plans
docs: Allows to patch one or more rate plans
- info:
name: Delete multiple rate plans
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/rate-plans
docs: Delete multiple rate plans
- info:
name: Returns number of rate plans
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/rate-plans/$count
docs: Returns number of rate plans
- info:
name: Get a rate plan
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}
docs: Get a rate plan
- info:
name: Replace a rate plan
type: http
http:
method: PUT
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}
docs: Replace a rate plan
- info:
name: Delete a rate plan
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/rate-plans/{id}
docs: Delete a rate plan
- info:
name: Archive a rate plan
type: http
http:
method: PUT
url: https://api.apaleo.com/rateplan/v1/rate-plan-actions/{id}/archive
docs: Archive a rate plan
- info:
name: Create a service.
type: http
http:
method: POST
url: https://api.apaleo.com/rateplan/v1/services
docs: Create a service.
- info:
name: Get all services.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/services
docs: Get all services.
- info:
name: Modify a service.
type: http
http:
method: PATCH
url: https://api.apaleo.com/rateplan/v1/services/{id}
docs: Modify a service.
- info:
name: Get a specific service.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/services/{id}
docs: Get a specific service.
- info:
name: Delete a service
type: http
http:
method: DELETE
url: https://api.apaleo.com/rateplan/v1/services/{id}
docs: Delete a service
- info:
name: Returns number of services.
type: http
http:
method: GET
url: https://api.apaleo.com/rateplan/v1/services/$count
docs: Returns number of services.
- info:
name: Availability
type: folder
items:
- info:
name: Get a list of all available units in a property
type: http
http:
method: GET
url: https://api.apaleo.com/availability/v1/units
docs: Get a list of all available units in a property
- info:
name: Get a list of all available unit groups in a property
type: http
http:
method: GET
url: https://api.apaleo.com/availability/v1/unit-groups
docs: Get a list of all available unit groups in a property
- info:
name: Allows to modify the unit group availability
type: http
http:
method: PATCH
url: https://api
# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/apaleo/refs/heads/main/apis.yml