For AI agents: visit https://developers.cloudbeds.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Home
Guides and Articles
API Reference
GraphQL
Changelog
Blueprints
v1.2
v1.3
Log In
API Reference
Search
Log In
v1.3
Home
Guides and Articles
API Reference
GraphQL
Changelog
Blueprints
Rate Plans
JUMP TO
Cloudbeds API Overview
Introduction
Tech Specs
Webhooks
Cloudbeds API
Authentication
metadata
get
access_token
post
userinfo
get
Adjustment
deleteAdjustment
del
postAdjustment
post
AllotmentBlocks
createAllotmentBlock
post
deleteAllotmentBlock
post
getAllotmentBlocks
get
updateAllotmentBlock
post
createAllotmentBlockNotes
post
listAllotmentBlockNotes
get
updateAllotmentBlockNotes
post
AppSettings
deleteAppPropertySettings
post
getAppPropertySettings
get
postAppPropertySettings
post
putAppPropertySettings
post
Currency
getCurrencySettings
get
CustomFields
getCustomFields
get
postCustomField
post
Dashboard
getDashboard
get
Emails
getEmailTemplates
get
postEmailTemplate
post
getEmailSchedule
get
postEmailSchedule
post
Groups
getGroupNotes
get
getGroups
get
patchGroup
post
postGroupNote
post
putGroup
post
Guest
getGuest
get
getGuestList
get
getGuestsModified
get
getGuestsByStatus
get
getGuestsByFilter
get
postGuestNote
post
getGuestNotes
get
putGuestNote
put
deleteGuestNote
del
putGuest
put
postGuestDocument
post
postGuest
post
postGuestsToRoom
post
postGuestPhoto
post
Hotel
getHotels
get
getHotelDetails
get
postFile
post
getFiles
get
HouseAccount
getHouseAccountList
get
postNewHouseAccount
post
putHouseAccountStatus
put
Housekeeping
getHousekeepingStatus
get
postHousekeepingStatus
post
postHousekeeper
post
putHousekeeper
put
getHousekeepers
get
postHousekeepingAssignment
post
Integration
getAppState
get
postAppState
post
postGovernmentReceipt
post
getAppSettings
get
postAppError
post
postWebhook
post
deleteWebhook
del
getWebhooks
get
Item
getItem
get
putItemToInventory
put
getItems
get
getItemCategories
get
postItemCategory
post
postItemsToInventory
post
postItem
post
postCustomItem
post
appendCustomItem
post
postVoidItem
post
Package
getPackages
get
getPackageNames
get
Payment
postPayment
post
postCustomPaymentMethod
post
getPaymentMethods
get
getPaymentsCapabilities
get
postVoidPayment
post
postCharge
post
postCreditCard
post
Rate
getRate
get
getRateJobs
get
getRatePlans
get
patchRate
post
putRate
post
Reservation
getReservation
get
postReservation
post
getReservations
get
getReservationsWithRateDetails
get
getReservationAssignments
get
postReservationNote
post
getReservationNotes
get
putReservationNote
put
deleteReservationNote
del
postReservationDocument
post
putReservation
put
getSources
get
Room
getRoomsFeesAndTaxes
get
postRoomAssign
post
postRoomCheckIn
post
postRoomCheckOut
post
getReservationRoomDetails
get
postRoomBlock
post
getRoomBlocks
get
putRoomBlock
put
getRoomTypes
get
getAvailableRoomTypes
get
getRooms
get
getRoomsUnassigned
get
deleteRoomBlock
post
Taxes and Fees
getTaxesAndFees
get
User
getUsers
get
Cloudbeds API v2
Addons
Retrieve property add-ons
get
Amenities
Get amenity catalog
get
Get amenity category catalog
get
Get property amenities
get
Update property amenities
put
Get amenities for all rooms in a property
get
Update amenities for multiple rooms
put
Get room amenities
get
Update room amenities
put
Applications
Get all connected API clients for a property
get
Door Locks
Get a list of doorlock keys for a specific app client and property.
get
Create a new doorlock key.
post
Delete a list of doorlock keys.
del
Delete a doorlock key.
del
Update a doorlock key.
patch
Get doorlock settings for property for specific application client.
get
Upsert doorlock settings for property for specific application client.
put
Delete doorlock settings for property for specific application client.
del
Events
List events for a property
get
Create a new event
post
Get a single event
get
Delete an event
del
Update an existing event
patch
List notes for an event
get
Create a note for an event
post
Update an event note
patch
Rate Plans
Housekeeping
Housekeeping inspection list
get
Integration Events
Get a list of integration events for a specific property.
get
Create a new integration event.
post
Update an integration event.
patch
Retry an integration event.
post
Items
Get a list of custom items for a specific property.
get
Post one or more items to a reservation, house account, or group profile
post
Market Segmentation
Get a list of Market Segmentation Groups.
get
Create a new Market Segmentation Group.
post
Get Market Segmentation Group data.
get
Delete a Market Segmentation Group.
del
Update a Market Segmentation Group.
patch
Enable a Market Segmentation Group.
post
Disable a Market Segmentation Group.
post
Get a list of Market Segmentation Segments.
get
Get Market Segmentation Segment data.
get
Delete a Market Segmentation Segment.
del
Update a Market Segmentation Segment.
patch
Get a list of reservations linked to a Market Segmentation Segment.
get
Create a new Market Segmentation Segment.
post
Enable a Market Segmentation Segment.
post
Disable a Market Segmentation Segment.
post
Set Market Segmentation Segment as Default.
post
Property
Retrieves the property's system component versions
get
Reservations
Smart Policy Exceptions
Search eligible rate plans and base rates with conflict info.
post
List all policy exceptions for a property.
get
Create a new policy exception.
post
Get a single policy exception by ID.
get
Update an existing policy exception.
put
Delete a policy exception.
del
Partially update a policy exception.
patch
Insights API
Chart
Get all charts
get
Search for a chart
get
Datasets
Get Datasets
get
Get Dataset by id
get
Get Dataset by id Updated At
get
List of multi-levels per dataset.
get
List of multi-level CDFs associated by dataset.
get
Get the CDF (Cloudbeds Data Field) picklist options
get
Get the CDF (Cloudbeds Data Field) picklist options for Multi level
get
Folders
List of Folders per property Id
get
Create a folder for a property
post
Get Folder by id
get
Update Folder
put
Delete folder by id
del
Assign a report to a folder
post
/datainsights/v1.1/folders/{id}/reports/{report_id}
del
Health
Get the health of the service
get
Hub
Get all hubs
get
Create a hub
post
Get a hub by id
get
Update a hub by id
put
Delete a hub by id
del
Get all hubs
get
Get a card by id
get
Update a card by id
put
Delete a card by id
del
Create a card linking a hub to a chart
post
Me
Get profile data about the current user
get
Get properties data about the current user
get
Get policies data about the current user
get
Reports
Get reports
get
Create a new report
post
Get report by id
get
Update report by id
put
Delete report by id
del
Clone report by id
post
Get report data by id
get
Get report summary by id
get
Get report export by id
get
Get report properties by id
get
Query report data
post
Query report summary
post
Query report data and export to file
post
Get custom cdfs on a report
get
Create a custom cdf on a report
post
Get custom cdf on a report
get
Update a custom cdf on a report
put
Delete a custom cdf on a report
del
Validate a custom cdf for a report
put
Get tags on report
get
Create an association between a Report and a tag
post
Delete an association between a Report and a tag
del
Get list of possible relative date entries
get
/datainsights/v1.1/reports/limits
get
Get list of available report format types
get
Get list of options for a given format type
get
Get report based on search results
get
/datainsights/v1.1/reports/{report_id}/charts
get
/datainsights/v1.1/reports/{report_id}/charts
post
/datainsights/v1.1/reports/{report_id}/charts/{chart_id}
get
/datainsights/v1.1/reports/{report_id}/charts/{chart_id}
put
/datainsights/v1.1/reports/{report_id}/charts/{chart_id}
del
Queue task to export report by id
post
Query report data and export to file
post
Queue task to export multiple reports by ids as single Excel workbook
post
Property
Get all the settings for an specific property
get
Get property settings with their options
get
Update property setting by name
put
Schedules
Get schedules
get
Create a schedule for a report workbook
post
Get schedule
get
Update a schedule by id
put
Delete schedule on a report
del
Get report export by id
post
Search
Search cross different resources
get
Stock reports
/datainsights/v1.1/stock_reports
get
Publish a new report
post
Get stock report by id
get
Update report by id
put
Unpublish stock report by id
del
Update report rules by id
put
Get stock report data by id
get
Get stock report summary by id
get
Get stock report export by id
get
Query stock report summary
post
Query stock report data
post
Get stock reports based on search results
get
Get keys of supported rules
get
Get keys of supported rules
get
Get keys of supported rules
get
Get keys of supported rules
get
Get keys of supported rules
get
/datainsights/v1.1/stock_reports/{stock_report_id}/revisions
get
/datainsights/v1.1/stock_reports/{stock_report_id}/revisions/{revision_id}
get
Query stock report data and export to file
post
Get custom cdfs of a stock report
get
Create a custom cdf for a stock report
post
Get custom cdf of a stock report
get
Update a custom cdf on a report
put
Delete a custom cdf of a stock report
del
Validate a custom cdf for a stock report
put
Clone stock report by id
post
/datainsights/v1.1/stock_reports/{stock_report_id}/charts
get
/datainsights/v1.1/stock_reports/{stock_report_id}/charts
post
/datainsights/v1.1/stock_reports/{stock_report_id}/charts/{chart_id}
get
/datainsights/v1.1/stock_reports/{stock_report_id}/charts/{chart_id}
put
/datainsights/v1.1/stock_reports/{stock_report_id}/charts/{chart_id}
del
List of stock report folders
get
Create a new stock report folder
post
Get Stock report folder by Id
get
Assign a stock report to a folder
post
/datainsights/v1.1/stock_reports/folders/{folder_id}
del
Remove a stock report from a folder
del
/datainsights/v1.1/stock_reports/limits
get
Get stock report export by id
post
Query stock report data and export to file
post
Tags
List of Tags per property Id
get
Create a tag for a property
post
Update a tag
put
Delete tag
del
Favorites
List of Favorites in a property for the user that is authorized
get
Create a favorite in a property for the user that is authorized
post
Get a Favorite by id
get
Update a rank
patch
Delete favorite
del
Liveness
Get the liveness probe of the service
get
Explore
/datainsights/v1.1/explore
get
Task
Get tasks
get
/datainsights/v1.1/tasks/{id}
get
/datainsights/v1.1/tasks/token/{token}
get
Accounting API
Settings
Get property accounting settings
get
Update property accounting settings
patch
Deposits
Transfer deposit transactions
post
Get deposit balance
get
List deposit transactions
get
Accounts Receivable Ledger
List accounts receivable ledgers
get
Create an accounts receivable ledger
post
Update an accounts receivable ledger
patch
Get an accounts receivable ledger by ID
get
List transactions for an AR ledger
get
Get AR ledger totals
get
Transfer a reservation balance to an AR ledger
post
Transfer a group profile balance to an AR ledger
post
Reverse a reservation-to-AR balance transfer
del
Get AR balance transfer details for a reservation
get
Custom General Ledger Codes
List custom general ledger codes
get
Create or update custom general ledger codes
put
Custom Transaction Codes
List custom transaction codes
get
Update custom transaction code mappings
put
Initialize custom transaction codes
post
Transactions
Search posted transactions
post
Search pending transactions
post
Folios
Get folio balance summary
get
List folios for a source
get
Create a folio
post
Update a folio
put
Delete a folio
del
Move transactions between folios
post
Route transactions to a group profile
post
Unroute transactions from a group profile
post
Search folio transactions
post
Trial balance
Check trial balance configuration status
get
Calculate initial trial balance
post
Get trial balance configuration
get
Configure trial balance
post
Get trial balance report
get
Internal transaction codes
List internal transaction codes
get
SourceBalance
Get source balance
get
/accounting/v1.0/source-balances/snapshots/{reservationId}
get
Folio Configuration
Partially update a folio configuration
patch
/accounting/v1.0/folios/configurations
get
Create or update a folio configuration
put
/accounting/v1.0/folios/configurations/{id}
get
Delete a folio configuration
del
/accounting/v1.0/folios/configurations/sources
get
/accounting/v1.0/folios/configurations/sources
put
Get autorouting rules
get
Create an autorouting rule
post
Update an autorouting rule
put
Get the structured filter tree of routable transaction types
get
Pay by Link
Pay By Link
Create a Pay By Link
post
Retrieve a Pay By Link
get
Fiscal document service API
Fiscal Documents
Get list of fiscal documents
get
Update a fiscal document by id
put
Get available transactions for fiscal documents
get
Get available transactions for allocations
get
Get payment allocation transactions
get
Get allocations summary
get
Get totals of selected available transactions for fiscal documents (deprecated)
get
Get list of transactions for a given fiscal document id
get
Get totals of transactions for a given fiscal document id
get
Get list of recipients associated to the fiscal document
get
Download fiscal document
get
Email a fiscal document
post
Create a fiscal document of the type invoice
post
Get fiscal document preview of the type invoice
post
Create a fiscal document of the type credit note
post
Get fiscal document preview of the type credit note
post
Create a fiscal document of the type rectify invoice
post
Get fiscal document preview of the type rectify invoice
post
Create a fiscal document of the type pro forma invoice
post
Create a fiscal document of the type pro forma invoice
post
Update pro forma invoice status
put
Create receipt for a payment.
post
Create simple receipts.
post
Void a receipt
post
Allocate payment associated with receipt to charge transactions.
post
Get allocations for an invoice
get
Get totals of selected available transactions for fiscal documents
post
Create a settlement invoice for an advance invoice
post
Apply receipt to invoice
post
Update require attention flag for a fiscal document
patch
Get count of fiscal documents with discrepancies
get
Get document creation rules for a given document kind
get
Configs
Get list of fiscal documents configs
get
Updates a config of a specific kind
put
Get logo image for fiscal documents
get
Upload logo image for fiscal documents
post
Delete logo image for fiscal documents
del
Get PDF document preview
get
Crop logo image for fiscal documents
patch
Fiscalization
Get fiscalization registration for a property
get
Create fiscalization registration
post
Update fiscalization registration
put
Get fiscalization rules for a country
get
Validate fiscalization registration data
post
Get available countries for property registration
get
Get registration status for a property
get
Get fiscalization provider info for a country
get
Record user consent for fiscalization
post
Get consent status for a property
get
Get fiscalization tax rules for a country
get
Get fiscalization tax for a property
get
Update fiscalization tax for a property
put
Set fiscalization credentials for a property
put
Get available series rules for a country
get
Get series configuration for a property
get
Update series configuration for a property
put
Generate and download a fiscalization report
get
Get fiscalization payment method rules for a country
get
Get fiscalization payment methods for a property
get
Update fiscalization payment methods for a property
put
Get fiscalization customization for a property
get
Update fiscalization customization for a property
put
Get fiscalization customization logo
get
Upload fiscalization customization logo
post
Delete fiscalization customization logo
del
Get fiscalization section values for a property
get
Update fiscalization section values for a property
put
Get item extension mapping rules for a country
get
Get item extension mappings for a property
get
Update item extension mappings for a property
put
Get fiscalization credentials status for a property
get
Upload a certificate for fiscalization credentials
post
Activate a series for a property
put
Deactivate a series for a property
put
Get fiscal operator rules for a country
get
List property users with their fiscal operator mapping
get
Update fiscal operator mappings for a property
put
Get fiscalization certificate status for a property
get
Features
Get enabled features for the current user and property
get
Export
Get folio list of transactions exported as PDF
post
Export folio transactions as PDF
post
Fiscal Connection Config
List supported countries
get
List fiscal channels for a country
get
List providers for a channel
get
Check if the property is ready to issue fiscal documents
get
List connections for a property
get
Create a connection
post
Get a single connection
get
Update a connection
put
Disconnect a connection
del
Activate a verifying connection
post
Pause a connection
post
Resume a paused connection
post
Test the connection to the tax authority
post
List available options for an onboarding step
get
Submit data for an onboarding step
post
Complete onboarding and activate connection
post
List in-progress connection drafts
get
Upsert a registration draft
put
Discard a registration draft
del
List all routing rules for a property
get
Bulk-replace routing rules
put
Update a single routing rule
patch
Group Profile API
Profile
List all profiles across all types
get
Create a new profile (any type)
post
Get profile by ID (any type)
get
Update profile (any type)
put
Delete profile (any type)
del
ProfilePerson
List person for a profile
get
Create a new person relationship for a profile
post
Unlink person from a profile
del
Find by person ID
get
ContactPerson
Search contact persons of organization
get
Add contact person to a profile (group, company, or travel agent)
post
Get contact person by ID
get
Update contact person for a profile (group, company, or travel agent)
put
Delete contact person from a profile (group, company, or travel agent)
del
ProfileNote
List notes for a profile
get
Add note to a profile
post
Get profile note by ID
get
Update profile note
put
Delete profile note
del
Archive profile note
post
Restore archived profile note
post
ProfileTag
List tags for profile
get
Assign Tag to a profile
post
Delete tag from profile
del
ProfileDocument
List documents for a profile
get
Upload document(s) to a profile
post
Get profile document metadata by ID
get
Delete profile document
del
Get document download URL
get
Payments Tokenization API
Card Tokenization
Tokenize a Card
post
Cloudbeds OTA Build-To-Us API
Introduction
Booking Format
Error Codes
Rate Plans
FAQ
Changelog
Connection
HealthCheck
post
SetupProperty
post
GetSubProperties
post
Content
CreateProperty
post
UpdateProperty
post
UpdateRoom
post
DeleteRoom
post
UpdateRatePlan
post
DeleteRatePlan
post
UpdateTaxes
post
Rooms & Rate Plans
GetRoomTypes
post
GetRatePlans
post
ARI
ARIUpdate
post
Bookings
GetBookingList
post
GetBookingId
post
AckBooking
post
CancelBooking
post
Getting Started
Groups
CreateGroup
post
UpdateGroup
post
DeleteGroup
post
CreateGroupBlock
post
UpdateGroupBlock
post
DeleteGroupBlock
post
Callbacks
ARIFullRefresh
post
CheckAvailability
post
BookingCreate
post
NotifyBooking
post
RoomInfo
post
ChannelList
post
GetARI
post
Payment SDK API
Payment SDK API Key Management
Issue API Key
post
List API Keys
get
Revoke API Key
del
Guest Profile API
Profiles
Returns a list of guest profiles
get
Create a new profile
post
Returns a single profile by ID
get
Update a profile
patch
Returns a value of PII field for a given profile
get
Returns the stats of a given profile.
get
Returns available filter values for guest profiles
get
Returns the sources of a given profile.
get
Anonymize a given profile.
post
Get custom fields for a profile
get
Returns a list of profiles currently merged into a given profile
get
ProfileMerges
Get a list of suggested merges.
get
Returns a list of guest profile merges
get
Merge profiles
post
Unmerge profiles
post
ProfileReservations
Returns a list of reservations for a given profile
get
Attribute Tagging Service API
Attributes
Returns a list of attributes
get
Create a new attribute
post
Update an attribute
patch
Delete an attribute
del
Tags
Returns a list of tags for an entity
get
Attach attributes to an entity
post
Delete multiple tags
del
Delete a tag
del
Returns tags for a list of entities (bulk lookup)
post
Powered by
Rate Plans
Updated 10 months ago
Update an event note
Housekeeping
Did this page help you?
Yes
No
Updated 10 months ago
Update an event note
Housekeeping
Did this page help you?
Yes
No
Copy Page
