For AI agents: visit https://developers.cloudbeds.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides and Articles API Reference GraphQL Changelog Blueprints

API Reference

Home Guides and Articles API Reference GraphQL Changelog Blueprints

Cloudbeds API Overview

Introduction
Tech Specs
Webhooks

Cloudbeds API

Authentication
Adjustment
- deleteAdjustmentdel
- postAdjustmentpost
AllotmentBlocks
AppSettings
Currency
- getCurrencySettingsget
CustomFields
- getCustomFieldsget
- postCustomFieldpost
Dashboard
- getDashboardget
Emails
Groups
Guest
Hotel
HouseAccount
Housekeeping
Integration
Item
Package
- getPackagesget
- getPackageNamesget
Payment
Rate
Reservation
Room
Taxes and Fees
- getTaxesAndFeesget
User
- getUsersget

Cloudbeds API v2

Addons
- Retrieve property add-onsget
Amenities
Applications
- Get all connected API clients for a propertyget
Checks
- Post a completed POS check (e.g., F&B) to a guest folio, house account, or group profilepost
- Void a posted check end-to-end (ledger + payments + its gratuities) by its checkIddel
Door Locks
Events
Gratuities
Housekeeping
- Housekeeping inspection listget
Integration Events
Items
- Get a list of custom items for a specific property.get
- Post one or more items to a reservation, house account, or group profilepost
Market Segmentation
Reservations
Property
- Retrieves the property's system component versionsget
Rate Plans
Smart Policies
- Preview how a folio adjustment (tax/fee/rate/room-revenue) would affect Smart Policy scheduled payments.post
- Get the rendered smart policy text and scheduled payments for a reservation.get
Smart Policy Exceptions

Insights API

Chart
- Get all chartsget
- Search for a chartget
Datasets
Folders
Health
- Get the health of the serviceget
Hub
Me
Reports
Property
Schedules
Search
- Search cross different resourcesget
Stock reports
Tags
Favorites
Liveness
- Get the liveness probe of the serviceget
Explore
- /datainsights/v1.1/exploreget
Task

Accounting API

Settings
- Get property accounting settingsget
- Update property accounting settingspatch
Deposits
Accounts Receivable Ledger
Custom General Ledger Codes
- List custom general ledger codesget
- Create or update custom general ledger codesput
Custom Transaction Codes
Transactions
- Search posted transactionspost
- Search pending transactionspost
Folios
Trial balance
Internal transaction codes
- List internal transaction codesget
SourceBalance
- Get source balanceget
- /accounting/v1.0/source-balances/snapshots/{reservationId}get
Folio Configuration

Pay by Link

Pay By Link
- Create a Pay By Linkpost
- Retrieve a Pay By Linkget

Fiscal document service API

Fiscal Documents
Configs
Features
- Get enabled features for the current user and propertyget
Export
- Get folio list of transactions exported as PDFpost
- Export folio transactions as PDFpost
Fiscalization
Fiscal Connection Config

Group Profile API

Profile
ProfilePerson
ContactPerson
ProfileNote
ProfileTag
ProfileDocument

Payments Tokenization API

Card Tokenization
- Tokenize a Cardpost

Cloudbeds OTA Build-To-Us API

Introduction
Booking Format
Error Codes
Rate Plans
FAQ
Changelog
Connection
Content
Rooms & Rate Plans
- GetRoomTypespost
- GetRatePlanspost
ARI
- ARIUpdatepost
Bookings
Getting Started
Groups
Callbacks

Payment SDK API

Payment SDK API Key Management

Guest Profile API

Profiles
ProfileMerges
ProfileReservations
- Returns a list of reservations for a given profileget

Attribute Tagging Service API

Attributes
Tags

Powered by

Reservations

Updated 10 months ago

Set Market Segmentation Segment as Default.

Did this page help you?

Updated 10 months ago

Set Market Segmentation Segment as Default.

Did this page help you?