Cloudbeds

Cloudbeds API v2

Welcome to the documentation for Cloudbeds API Version v2 ! If you are looking to learn how to use the Cloudbeds API to access guest information,…

Travel#openapi

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 v2 ! 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/{method} HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it. Request Format: HTTP GET, POST, PUT, PATCH and DELETE; request bodies are JSON (Content-Type: application/json) 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 73

Addons

  • GETRetrieve property add-ons/addons/v1/addonsFetches list of Add-ons with basic information for a specific property
  • DELETEVoid an add-on on a reservation/addons/v1/reservations/:reservationId/addons/:soldAddonIdVoids one add-on on a reservation, with its charge, taxes and fees, the same way the MFD UI does. Idempotent: voiding an already-voided add-on returns 204.

Amenities

  • GETGet amenity catalog/amenities/v1/catalogs/amenities?scope=propertyReturns the complete list of amenities available for the specified scope (property or room) with their translated names and category codes.
  • GETGet amenity category catalog/amenities/v1/catalogs/categories?scope=propertyReturns the complete list of amenity categories available for the specified scope (property or room) with their translated names.
  • GETGet property amenities/amenities/v1/properties/:propertyId/amenitiesRetrieve the complete set of active property amenities.
  • PUTUpdate property amenities/amenities/v1/properties/:propertyId/amenitiesReplace the complete set of active property amenities in a single atomic transaction.
  • GETGet amenities for all rooms in a property/amenities/v1/properties/:propertyId/room-amenitiesRetrieve the complete set of active amenities for all rooms in a property.
  • PUTUpdate amenities for multiple rooms/amenities/v1/properties/:propertyId/room-amenitiesReplace the complete set of active amenities for multiple rooms in a single atomic transaction.
  • GETGet room amenities/amenities/v1/properties/:propertyId/rooms/:roomTypeId/amenitiesRetrieve the complete set of active room amenities.
  • PUTUpdate room amenities/amenities/v1/properties/:propertyId/rooms/:roomTypeId/amenitiesReplace the complete set of active room amenities in a single atomic transaction.

Applications

  • GETGet all connected API clients for a property/integration/v1/connected-applications

booking-room

  • GETGet rooms a reservation can be reassigned to/booking-room/v1/:bookingRoomId/assignable-roomsReturns the reservation's current room assignment, the property's room types, and the rates and rooms available for a room type: the reservation's current…

Checks

  • POSTPost a completed POS check (e.g., F&B) to a guest folio, house account, or group profile/folio/v1/checksReplaces postCustomItem with first-class folio transactions enriched with hospitality POS context (check identity, revenue center, meal period, gratuity,…
  • DELETEVoid a posted check end-to-end (ledger + payments + its gratuities) by its checkId/folio/v1/checks/:checkIdVoids the whole check: reverses each line (item / service charge / discount) and its tax/fee children on both CDC and DOMAIN, cascade-voids every gratuity…

Door Locks

  • GETGet a list of doorlock keys for a specific app client and property./doorlock/v1/keys/:propertyId
  • POSTCreate a new doorlock key./doorlock/v1/keys
  • DELETEDelete a list of doorlock keys./doorlock/v1/keys?keyIds=1,2
  • DELETEDelete a doorlock key./doorlock/v1/keys/:id
  • PATCHUpdate a doorlock key./doorlock/v1/keys/:id
  • GETGet doorlock settings for property for specific application client./doorlock/v1/settings/:propertyId
  • PUTUpsert doorlock settings for property for specific application client./doorlock/v1/settings/:propertyId
  • DELETEDelete doorlock settings for property for specific application client./doorlock/v1/settings/:propertyId

Events

  • GETList events for a property/events/v2/eventsReturns a paginated list of events for a property. Events contain operational data and reference group profiles via profileId.
  • POSTCreate a new event/events/v2/eventsCreates a new event associated with an existing group profile or without any profile association.
  • GETGet a single event/events/v2/events/:eventIdReturns detailed information about a specific event.
  • DELETEDelete an event/events/v2/events/:eventIdDeletes an event by ID or event code. This is a soft delete.
  • PATCHUpdate an existing event/events/v2/events/:eventIdUpdates an event. Only provided fields are updated. For profileId: omit to keep, null to clear, string to replace.
  • GETList notes for an event/events/v2/events/:eventId/notesReturns a paginated list of notes for a specific event.
  • POSTCreate a note for an event/events/v2/events/:eventId/notesCreates a new note for a specific event.
  • PATCHUpdate an event note/events/v2/events/:eventId/notes/:noteIdUpdates an existing note or archives it.

Gratuities

  • POSTPost one or more guest tips to a folio, house account, or group profile/folio/v1/gratuitiesPosts one or more tips (ITC 8995) as first-class folio transactions. Recipient attribution and POS context are stored MFD-side only; the Accounting Service…
  • POSTPost one or more guest tips linked to an existing check/folio/v1/checks/:checkId/gratuitiesPosts one or more tips (ITC 8995) linked to the check identified by the path {checkId}. The gratuities inherit the check's folio target and checkNumber; POS…
  • DELETEVoid a posted gratuity by its gratuityId/folio/v1/gratuities/:gratuityIdVoids a single gratuity (as returned at post time) — reverses its tip line and its tax children on both CDC and DOMAIN. Idempotent: voiding an already-voided…

Housekeeping

  • GETHousekeeping inspection list/housekeeping/v1/inspections/:propertyId

Integration Events

  • GETGet a list of integration events for a specific property./integration/v1/events
  • POSTCreate a new integration event./integration/v1/events
  • PATCHUpdate an integration event./integration/v1/events/:id
  • POSTRetry an integration event./integration/v1/events/:id/retry

Items

  • GETGet a list of custom items for a specific property./item/v1/custom-items
  • POSTPost one or more items to a reservation, house account, or group profile/item/v1/itemsAdds items to a reservation, house account, or group profile. This endpoint supports batch operations, allowing multiple items to be posted in a single…

Market Segmentation

  • GETGet a list of Market Segmentation Groups./market-segmentation/v1/groups
  • POSTCreate a new Market Segmentation Group./market-segmentation/v1/groups
  • GETGet Market Segmentation Group data./market-segmentation/v1/groups/:id
  • DELETEDelete a Market Segmentation Group./market-segmentation/v1/groups/:id
  • PATCHUpdate a Market Segmentation Group./market-segmentation/v1/groups/:id
  • POSTEnable a Market Segmentation Group./market-segmentation/v1/groups/:id/enable
  • POSTDisable a Market Segmentation Group./market-segmentation/v1/groups/:id/disable
  • GETGet a list of Market Segmentation Segments./market-segmentation/v1/segments/:enabled
  • GETGet Market Segmentation Segment data./market-segmentation/v1/segments/:id
  • DELETEDelete a Market Segmentation Segment./market-segmentation/v1/segments/:id
  • PATCHUpdate a Market Segmentation Segment./market-segmentation/v1/segments/:id
  • GETGet a list of reservations linked to a Market Segmentation Segment./market-segmentation/v1/segments/:id/reservations/:active
  • POSTCreate a new Market Segmentation Segment./market-segmentation/v1/segments
  • POSTEnable a Market Segmentation Segment./market-segmentation/v1/segments/:id/enable
  • POSTDisable a Market Segmentation Segment./market-segmentation/v1/segments/:id/disable
  • POSTSet Market Segmentation Segment as Default./market-segmentation/v1/segments/:id/default

Marketing Performance

  • GETGet daily Digital Marketing (Amplify) performance./digital-marketing/v1/daily-performance?startDate=2024-01-01&endDate=2024-01-01Returns Digital Marketing (Amplify) performance per property, day and campaign type: impressions, clicks, spend, attributed reservations and revenue, for the…

Payments

  • POSTCreate a payment or authorization/payments/v1/paymentsCreates a payment with the specified capture mode. Use 'auto' for immediate charge, 'manual' for authorization only.

Property

  • GETRetrieves the property's system component versions/property/v1/system

Rate Plans

  • GETGet a list of Rates Plans./rates/v1/rate-plans
  • POSTCreate a new Rate Plan./rates/v1/rate-plans
  • GETGet Rate Plan data./rates/v1/rate-plans/:id
  • DELETEDelete a Rate Plan./rates/v1/rate-plans/:id
  • PATCHUpdate an existing Rate Plan./rates/v1/rate-plans/:id
  • POSTActivate or deactivate several Rate Plans in one request./rates/v1/rate-plans/bulk-statusEvery id must belong to the property, otherwise the whole request is rejected. Rate plans already in the requested state are reported as unchanged. A rate…

Smart Policies

  • GETGet the rendered smart policy text and scheduled payments for a reservation./smart-policies/v1/reservations/:reservationId/policy-information

Smart Policy Exceptions

  • POSTSearch eligible rate plans and base rates with conflict info./smart-policies/v1/exceptions/eligible-rates/search
  • GETList all policy exceptions for a property./smart-policies/v1/exceptions
  • POSTCreate a new policy exception./smart-policies/v1/exceptions
  • GETGet a single policy exception by ID./smart-policies/v1/exceptions/:exceptionId
  • PUTUpdate an existing policy exception./smart-policies/v1/exceptions/:exceptionId
  • DELETEDelete a policy exception./smart-policies/v1/exceptions/:exceptionId
  • PATCHPartially update a policy exception./smart-policies/v1/exceptions/:exceptionId

API details

Base URL
https://api.cloudbeds.com
Authentication
An API key in the x-api-key header
OAuth 2.0 (authorization code flow) with 21 scopes
Operations
73 operations on 49 pathsGET 28POST 21DELETE 11PATCH 8PUT 5
Main resources
Market Segmentation 16Amenities 8Door Locks 8Events 8Smart Policy Exceptions 7Rate Plans 6Integration Events 4Gratuities 3Addons 2Checks 2
Response formats
application/json application/problem+json text/csv
Description format
OpenAPI 3.0.0, API version v2

How to test the Cloudbeds API v2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Cloudbeds API v2 collection, without the publisher's secrets.
  3. 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.
  4. Send a requestPick an endpoint, for example “Retrieve property add-ons” (GET /addons/v1/addons), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Cloudbeds API v2?

Welcome to the documentation for Cloudbeds API Version v2 ! If you are looking to learn how to use the Cloudbeds API to access guest information,… It is listed under Travel and has 73 endpoints.

Who publishes the Cloudbeds API v2?

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 v2?

Requests go to https://api.cloudbeds.com. Endpoint paths are added to this base URL.

How do I authenticate with the Cloudbeds API v2?

It accepts 2 methods: an API key in the x-api-key header; OAuth 2.0 (authorization code flow) with 21 scopes.

How many endpoints does the Cloudbeds API v2 have?

73 operations on 49 paths (28 GET, 21 POST, 11 DELETE, 8 PATCH, 5 PUT). The largest groups are Market Segmentation, Amenities, Door Locks, Events.

Is forking the Cloudbeds API v2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.