Cloudbeds API
Welcome to the documentation for Cloudbeds API Version v1.3 ! If you are looking to learn how to use the Cloudbeds API to access guest information,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Welcome to the documentation for Cloudbeds API Version v1.3 !
If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data
for your Cloudbeds customers, then you've come to the right place.
In this document you will find all the API methods we provide along with explanations for parameters and response
examples.
If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our
Integrations Portal .
Be sure to subscribe to the monthly
Cloudbeds API announcement mailing list to receive information on new additions and improvements to the
Cloudbeds API and related developer tools.
Endpoint: https://api.cloudbeds.com/api/v1.3/{method}
HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.
Request Format: HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)
Response Format: JSON
Response Header: X-Request-ID is added to response headers in all calls to help accelerate support
and troubleshooting.
use this link to access our Public collection in Postman.
Endpoints 116
Authentication
- GETmetadata
/oauth/metadataIn the context of properties being distributed across multiple localizations, this endpoint serves to retrieve the precise location of the property associated… - POSTaccess_token
/access_tokenQuery the authorization server for an access token used to access property resources.</br> If the automatic delivery method for API keys is used, the grant… - GETuserinfo
/userinfoReturns information on user who authorized connection
Adjustment
- POSTdeleteAdjustment
/deleteAdjustmentVoids the AdjustmentID transaction on the specified reservationID - POSTpostAdjustment
/postAdjustmentAdds an adjustment to a reservation
AllotmentBlocks
- POSTcreateAllotmentBlock
/createAllotmentBlockRetreive allotment blocks @apiQuery {Integer} propertyID Property ID - POSTdeleteAllotmentBlock
/deleteAllotmentBlockDelete allotment blocks - GETgetAllotmentBlocks
/getAllotmentBlocks?propertyID=stringRetrieve allotment blocks - POSTupdateAllotmentBlock
/updateAllotmentBlockUpdate an allotment block @apiQuery {Integer} propertyID Property ID - POSTcreateAllotmentBlockNotes
/createAllotmentBlockNotesAdd a note to an allotment block - GETlistAllotmentBlockNotes
/listAllotmentBlockNotes?propertyID=string&allotmentBlockCode=stringList notes added to an allotment block - POSTupdateAllotmentBlockNotes
/updateAllotmentBlockNotesUpdate a note on an allotment block
AppSettings
- POSTdeleteAppPropertySettings
/deleteAppPropertySettings - GETgetAppPropertySettings
/getAppPropertySettings?propertyID=stringReturns the app property settings - POSTpostAppPropertySettings
/postAppPropertySettings - POSTputAppPropertySettings
/putAppPropertySettings
Currency
- GETgetCurrencySettings
/getCurrencySettingsGet currency settings
CustomFields
- GETgetCustomFields
/getCustomFieldsGets custom fields list<br /> ¹ data.displayed = "booking" - Display this field to guests on the booking engine.<br /> ¹ data.displayed = "reservation" - Add… - POSTpostCustomField
/postCustomFieldSets custom fields. The call should only be made once to add the field to the system.
Dashboard
- GETgetDashboard
/getDashboardReturns basic information about the current state of the hotel
Emails
- GETgetEmailTemplates
/getEmailTemplatesReturns a list of all existing email templates. This call is only available for third-party integration partners, and not for property client IDs. - POSTpostEmailTemplate
/postEmailTemplateCreates a new email template. See the full list of available language parameters <a… - GETgetEmailSchedule
/getEmailScheduleReturns a list of all existing email scheduling. This call is only available for third-party integration partners, and not for property client IDs. - POSTpostEmailSchedule
/postEmailScheduleCreates a new email schedule for existing email template. Email template can be scheduled based on two parameters: reservationStatusChange and…
Groups
- GETgetGroupNotes
/getGroupNotes?propertyID=string&eventCode=string&pageSize=0&pageNumber=0Returns group notes - GETgetGroups
/getGroups?propertyID=stringReturns the groups for a property - POSTpatchGroup
/patchGroupUpdates an existing group with information provided. At least one information field is required for this call. - POSTpostGroupNote
/postGroupNoteAdds a group note - POSTputGroup
/putGroupAdds a group to the property. Please note that the default setting for 'Route to Group Folio' will be 'No,' and the 'Reservation Folio Configuration' will be…
Guest
- GETgetGuest
/getGuestReturns information on a guest specified by the Reservation ID parameter - GETgetGuestList
/getGuestListReturns a list of guests, ordered by modification date ### Group account support - GETgetGuestsModified
/getGuestsModifiedReturns a list of guests based on their modification date. Note that when a guest checks in or checks out of a room, their record is modified at that time. If… - GETgetGuestsByStatus
/getGuestsByStatus?status=canceledReturns a list of guests in the current status (Not Checked In, In House, Checked Out or Cancelled), sorted by modification date. If no date range is passed,… - GETgetGuestsByFilter
/getGuestsByFilter?status=cancelledReturns a list of guests matching the selected parameters ### Group account support - POSTpostGuestNote
/postGuestNoteAdds a guest note - GETgetGuestNotes
/getGuestNotes?guestID=stringRetrieves a guest notes - PUTputGuestNote
/putGuestNoteUpdates an existing guest note. - DELETEdeleteGuestNote
/deleteGuestNote?guestID=string¬eID=stringArchives an existing guest note. - PUTputGuest
/putGuestUpdates an existing guest with information provided. At least one information field is required for this call. - POSTpostGuestDocument
/postGuestDocumentAttaches a document to a guest - POSTpostGuest
/postGuestAdds a guest to reservation as an additional guest. - POSTpostGuestsToRoom
/postGuestsToRoomAssigns guest(s) to a room in a reservation and adds these guests as additional guests. - POSTpostGuestPhoto
/postGuestPhotoAttaches a photo to a guest
Hotel
- GETgetHotels
/getHotelsReturns a list of hotels, filtered by the parameters passed ### Group account support - GETgetHotelDetails
/getHotelDetailsReturns the details of a specific hotel, identified by "propertyID" - POSTpostFile
/postFileAttaches a file to a hotel - GETgetFiles
/getFilesReturns a list of files attached to a hotel or group profile, ordered by creation date
HouseAccount
- GETgetHouseAccountList
/getHouseAccountListPulls list of active house accounts - POSTpostNewHouseAccount
/postNewHouseAccountAdd a new House Account - PUTputHouseAccountStatus
/putHouseAccountStatusChange specific house account to either open or closed.
Housekeeping
- GETgetHousekeepingStatus
/getHousekeepingStatusReturns the current date's housekeeping information The housekeeping status is calculated based on the set of fields The available statuses are: <table>… - POSTpostHousekeepingStatus
/postHousekeepingStatusSwitches the current date's housekeeping status for a specific room ID to either clean or dirty The housekeeping status is calculated based on the set of… - POSTpostHousekeeper
/postHousekeeperAdd New Housekeeper - PUTputHousekeeper
/putHousekeeperEdit Housekeeper Details - GETgetHousekeepers
/getHousekeepersReturns a list of housekeepers ### Group account support - POSTpostHousekeepingAssignment
/postHousekeepingAssignmentAssign rooms (single or multiple) to an existing housekeeper
Integration
- GETgetAppState
/getAppStateGet the current app integration state for a property.<br /> This call is only available for third-party integration partners, and not for property client IDs.… - POSTpostAppState
/postAppStateUpdate app integration state for a property ID. <br /> This call is only available for third-party integration partners, and not for property client IDs. <br… - POSTpostGovernmentReceipt
/postGovernmentReceiptAdd a Government Receipt to a Reservation or House Account - GETgetAppSettings
/getAppSettingsGet the current app settings for a property.<br /> - POSTpostAppError
/postAppErrorSubmit the error received by the hybrid integration from the partner to the MFD - POSTpostWebhook
/postWebhookSubscribe a webhook for a specified event. Read the Webhooks guide to see available objects, actions, payload info and more. - DELETEdeleteWebhook
/deleteWebhook?subscriptionID=stringRemove subscription for webhook. Read the Webhooks guide to see available objects, actions, payload info and more. ### Group account support - GETgetWebhooks
/getWebhooksList webhooks for which the API client is subscribed to.
Item
- GETgetItem
/getItem?itemID=stringGets the details for the one itemID<br /> <sup>1</sup> only if data.stockInventory = true<br> <sup>2</sup> Taxes, fees and totals will show up only if an item… - PUTputItemToInventory
/putItemToInventoryUpdates an item with information provided<br /> ¹ only if item.stockInventory = true<br /> - GETgetItems
/getItemsGets all the items and their prices the hotel has created in myfrontdesk<br> <sup>1</sup> only if data.stockInventory = true<br> <sup>2</sup> Taxes, fees and… - GETgetItemCategories
/getItemCategoriesGets the item category list - POSTpostItemCategory
/postItemCategoryAdds new items category - POSTpostItemsToInventory
/postItemsToInventoryAdds new items batch<br /> ¹ only if item.stockInventory = true<br /> - POSTpostItem
/postItemAdds an item either to a reservation or to a house account. - POSTpostCustomItem
/postCustomItemAdds single, or multiple, custom items and their associated payments to a Reservation or House Account as a single transaction. - POSTappendCustomItem
/appendCustomItemAppend single, or multiple, custom items and their associated payments to an existing one in a Reservation, House Account, or Group. - GETgetCustomItem
/getCustomItemReturns every item and payment of one posting made with postCustomItem, including the items and payments added to it later with appendCustomItem. Look the… - POSTpostVoidItem
/postVoidItemVoids the itemID transaction on the specified Reservation ID, House Account ID, or Group. If payments were sent in calls postItem or postCustomItem, they will…
Package
- GETgetPackages
/getPackagesThis efficient method allows you to retrieve the collection of packages associated with a property. Packages here define a group of features that a property… - GETgetPackageNames
/getPackageNamesReturn a list of billing package names for a property
Payment
- POSTpostPayment
/postPaymentAdd a payment to a specified reservation, house account, or group. If multiple IDs are provided, precedence is reservationID, then houseAccountID, then… - POSTpostCustomPaymentMethod
/postCustomPaymentMethodAdd a Custom Payment Method to a property. This call does not allow to add Payment Methods: credit cards, bank transfer or Pay Pal. - GETgetPaymentMethods
/getPaymentMethodsGet a list of active methods for a property, or list of properties - GETgetPaymentsCapabilities
/getPaymentsCapabilitiesLists the payment capabilities of a given property - POSTpostVoidPayment
/postVoidPaymentVoids a payment (using paymentID) to a specified reservation or house account. - POSTpostCharge
/postChargeUse a payment method to process a payment on a reservation, group profile, accounts receivable ledger, or house account. - POSTpostCreditCard
/postCreditCardReturns the rate of the room type selected, based on the provided parameters
Rate
- GETgetRate
/getRate?roomTypeID=string&startDate=2024-01-01&endDate=2024-01-01Returns the rate of the room type selected, based on the provided parameters - GETgetRateJobs
/getRateJobsReturns a list of Rate Jobs. Rate jobs are only returned within 7 days of creation, after 7 days they will not be returned in the response. Requests which do… - GETgetRatePlans
/getRatePlans?startDate=2024-01-01&endDate=2024-01-01Returns the rates of the room type or promo code selected, based on the provided parameters. If no parameters are provided, then the method will return all… - POSTpatchRate
/patchRateUpdate the rate of the room based on rateID selected, based on the provided parameters. You can make multiple rate updates in a single API call. Providing a… - POSTputRate
/putRateUpdate the rate of the room based on rateID selected, based on the provided parameters. You can make multiple rate updates in a single API call. Providing a…
Reservation
- GETgetReservation
/getReservation?reservationID=stringReturns information on a booking specified by the reservationID parameter - POSTpostReservation
/postReservationAdds a reservation to the selected property - GETgetReservations
/getReservationsReturns a list of reservations that matched the filters criteria.<br /> Please note that some reservations modification may not be reflected in this… - GETgetReservationsWithRateDetails
/getReservationsWithRateDetailsReturns a list of reservations with added information regarding booked rates and sources.<br /> Please note that some reservations modification may not be… - GETgetReservationAssignments
/getReservationAssignmentsReturns a list of rooms/reservations assigned for a selected date. - POSTpostReservationNote
/postReservationNoteAdds a reservation note - GETgetReservationNotes
/getReservationNotes?reservationID=stringRetrieves reservation notes based on parameters - PUTputReservationNote
/putReservationNoteUpdates an existing reservation note. - DELETEdeleteReservationNote
/deleteReservationNote?reservationID=string&reservationNoteID=stringArchives an existing reservation note. - POSTpostReservationDocument
/postReservationDocumentAttaches a document to a reservation - PUTputReservation
/putReservationUpdates a reservation, such as custom fields, estimated arrival time, room configuration and reservation status. - GETgetSources
/getSourcesGets available property sources
Room
- GETgetRoomsFeesAndTaxes
/getRoomsFeesAndTaxes?startDate=2024-01-01&endDate=2024-01-01&roomsTotal=0.0&roomsCount=0Get applicable fees and tax to a booking. This is meant to be used on checkout to display to the guest. - POSTpostRoomAssign
/postRoomAssignAssign/Reassign a room on a guest reservation - POSTpostRoomCheckIn
/postRoomCheckInCheck-in a room already assigned for a guest - POSTpostRoomCheckOut
/postRoomCheckOutCheck-out a room already assigned for a guest. If all rooms are checked out, the reservation status will update accordingly to "Checked Out" as well. - GETgetReservationRoomDetails
/getReservationRoomDetails?subReservationID=stringReturns information about particular room in reservation by its subReservationID - POSTpostRoomBlock
/postRoomBlockAdds a room block to the selected property. - GETgetRoomBlocks
/getRoomBlocksReturns a list of all room blocks considering the informed parameters. - PUTputRoomBlock
/putRoomBlockUpdates a room block. - POSTdeleteRoomBlock
/deleteRoomBlockDeletes a room block - GETgetRoomTypes
/getRoomTypesReturns a list of room types filtered by the selected parameters ### Group account support - GETgetAvailableRoomTypes
/getAvailableRoomTypes?startDate=2024-01-01&endDate=2024-01-01&rooms=1&adults=1&children=0Returns a list of room types with availability considering the informed parameters ### Group account support - GETgetRooms
/getRoomsReturns a list of all rooms considering the informed parameters. If Check-in/out dates are sent, only unassigned rooms are returned. ### Group account support - GETgetRoomsUnassigned
/getRoomsUnassignedReturns a list of unassigned rooms in the property. Call is alias of getRooms. Please check its documentation for parameters, response and example. ### Group…
Taxes and Fees
- GETgetTaxesAndFees
/getTaxesAndFeesReturns the taxes and fees set for the property. Read the Rate-Based tax (Dynamic Tax) guide to understand its usage.
User
- GETgetUsers
/getUsersReturns information on the properties' users. For authenticated users without hotel_users permission, email, role, and last-login fields are omitted. Client…
API details
- Base URL
https://api.cloudbeds.com/api/v1.3- Authentication
- An API key in the x-api-key header
OAuth 2.0 (authorization code flow) with 40 scopes - Operations
- 116 operations on 116 pathsGET 53POST 52PUT 8DELETE 3
- Main resources
- Guest 14Room 13Reservation 12Item 11Integration 8AllotmentBlocks 7Payment 7Housekeeping 6Groups 5Rate 5
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
v1.3 - Links
- OpenAPI document
- Listed from
- Cloudbeds's published OpenAPI description (cloudbeds/openapi-specs) (MIT)
How to test the Cloudbeds API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Cloudbeds API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the x-api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “metadata” (GET /oauth/metadata), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Cloudbeds API?
Welcome to the documentation for Cloudbeds API Version v1.3 ! If you are looking to learn how to use the Cloudbeds API to access guest information,… It is listed under Travel and has 116 endpoints.
Who publishes the Cloudbeds API?
It is listed from Cloudbeds's public API description (an OpenAPI document), not published by Cloudbeds on Swastik Codes. Anyone who controls cloudbeds.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Cloudbeds API?
Requests go to https://api.cloudbeds.com/api/v1.3. Endpoint paths are added to this base URL.
How do I authenticate with the Cloudbeds API?
It accepts 2 methods: an API key in the x-api-key header; OAuth 2.0 (authorization code flow) with 40 scopes.
How many endpoints does the Cloudbeds API have?
116 operations on 116 paths (53 GET, 52 POST, 8 PUT, 3 DELETE). The largest groups are Guest, Room, Reservation, Item.
Is forking the Cloudbeds API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.