Jump to Content
Home
Guides and Articles
API Reference
Changelog
v1.2
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.2
Home
Guides and Articles
API Reference
Changelog
putHousekeeper
Search
JUMP TO
Cloudbeds API
Introduction
Tech Specs
Webhooks
Authentication
metadata
get
access_token
post
userinfo
get
Adjustment
deleteAdjustment
delete
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
delete
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
delete
getWebhooks
get
Invoices
getInvoice
get
patchInvoice
post
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
getReservationInvoiceInformation
get
postReservationNote
post
getReservationNotes
get
putReservationNote
put
deleteReservationNote
delete
postReservationDocument
post
putReservation
put
getSources
get
Room
getRoomsFeesAndTaxes
get
postRoomAssign
post
postRoomCheckIn
post
postRoomCheckOut
post
getReservationRoomDetails
get
postRoomBlock
post
getRoomBlocks
get
putRoomBlock
put
deleteRoomBlock
delete
getRoomTypes
get
getAvailableRoomTypes
get
getRooms
get
getRoomsUnassigned
get
Taxes and Fees
getTaxesAndFees
get
User
getUsers
get
Data 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
delete
Assign a report to a folder
post
/datainsights/v1.1/folders/{id}/reports/{report_id}
delete
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
delete
Get all hubs
get
Get a card by id
get
Update a card by id
put
Delete a card by id
delete
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
delete
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
delete
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
delete
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}
delete
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
delete
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
delete
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
delete
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}
delete
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}
delete
Remove a stock report from a folder
delete
/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
delete
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
delete
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 service API
Deposits
/accounting/v1.0/deposits/transfer
post
/accounting/v1.0/deposits/balance
get
/accounting/v1.0/deposits/transactions
get
Accounts Receivable Ledger
/accounting/v1.0/accounts-receivable-ledgers
get
/accounting/v1.0/accounts-receivable-ledgers
post
/accounting/v1.0/accounts-receivable-ledgers
patch
/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}
get
/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/transactions
get
/accounting/v1.0/accounts-receivable-ledgers/totals
get
/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/reservation/{reservationId}/balance-transfer
post
/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/reservation/{reservationId}/balance-transfer
delete
/accounting/v1.0/accounts-receivable-ledgers/reservation/{reservationId}/balance-transfer
get
Custom General Ledger Codes
/accounting/v1.0/custom-general-ledger-codes
get
/accounting/v1.0/custom-general-ledger-codes
put
Custom Transaction Codes
/accounting/v1.0/custom-transaction-codes
get
/accounting/v1.0/custom-transaction-codes
put
/accounting/v1.0/custom-transaction-codes/initialize
post
Transactions
/accounting/v1.0/transactions
post
Trial balance
/accounting/v1.0/trial-balance/configuration/status
get
/accounting/v1.0/trial-balance/configuration/calculate
post
/accounting/v1.0/trial-balance/configuration
get
/accounting/v1.0/trial-balance/configuration
post
/accounting/v1.0/trial-balance/report
get
Internal transaction codes
/accounting/v1.0/internal-transaction-codes
get
Pay by Link
Pay By Link
Create a Pay By Link
post
Retrieve a Pay By Link
get
Cloudbeds API
doorlock-keys
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.
delete
Delete a doorlock key.
delete
Update a doorlock key.
patch
doorlock-settings
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.
delete
housekeeping
Housekeeping inspection list
get
import-tasks
Fetch a list of previously uploaded imports.
get
Create a new import task and generate a temporary upload URL.
post
Fetch import task by ID.
get
ReImport an import task and generate a temporary upload URL.
post
Download import task as a CSV file.
get
Fetch import task records by ID.
get
Import task re-process records
post
Powered by
putHousekeeper
put
https://api.cloudbeds.com/api/v1.2/putHousekeeper
Edit Housekeeper Details
Language
Shell
Node
Ruby
PHP
Python
Credentials
Client
Scopes
Missing 1 required scope
RESPONSE
Click
Try It!
to start a request and see the response here!