--- name: cloudbeds description: "

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 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.

" version: "0.1.0" license: MIT --- # Cloudbeds

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 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.

Give your agent hands-on access to Cloudbeds. Ask for what you need in plain language — your agent runs the right command and gets structured JSON back, ready to act on. No tab-switching, no copy-paste: 57 operations across 10 areas, runnable from chat or any automation. ## What you can do - **Addons** — Addons - **Amenities** — Amenities - **Doorlock** — Manage doorlock - **Events** — Events - **Housekeeping** — Housekeeping - **Integration** — Manage integration - **Item** — Items - **Market Segmentation** — Market Segmentation - **Property** — Property - **Smart Policies** — Manage smart policies Each area ships with a bundled skill that teaches your agent the commands, flags, and common workflows — install and it knows what to do. ## Quick Start ```bash # Check connectivity $CLOUDBEDS_BIN ping # See all available commands $CLOUDBEDS_BIN --help ``` ## Authentication This plugin uses OAuth (authorization code) to connect to your Cloudbeds account. 1. Create an OAuth application in the Cloudbeds developer console 2. Set the redirect URI to `http://localhost:31750/callback` 3. Set `CLOUDBEDS_CLIENT_ID` and `CLOUDBEDS_CLIENT_SECRET` environment variables ```bash # Start the OAuth login flow $CLOUDBEDS_BIN auth login # Check auth status $CLOUDBEDS_BIN auth status ``` ## Commands | Command | What it does | |---------|--------------| | `ping` | Check API reachability | | `doctor` | Verify credentials and connectivity | | `addons get` | Fetches list of Add-ons with basic information for a specific property | | `amenities amenity-catalog-get-amenity-catalog` | Returns the complete list of amenities available for the specified scope (property or room) with their translated names and category codes. | | `amenities amenity-catalog-get-amenity-category-catalog` | Returns the complete list of amenity categories available for the specified scope (property or room) with their translated names. | | `amenities property-amenity-get-property` | Retrieve the complete set of active property amenities. | | `amenities property-amenity-update-property` | Replace the complete set of active property amenities in a single atomic transaction. | | `amenities room-amenity-get-property-rooms` | Retrieve the complete set of active amenities for all rooms in a property. | | `amenities room-amenity-get-room` | Retrieve the complete set of active room amenities. | | `amenities room-amenity-update-property-rooms` | Replace the complete set of active amenities for multiple rooms in a single atomic transaction. | | `amenities room-amenity-update-room` | Replace the complete set of active room amenities in a single atomic transaction. | | `doorlock door-lock-key-batch-delete` | Delete a list of doorlock keys. | | `doorlock door-lock-key-create` | Create a new doorlock key. | | `doorlock door-lock-key-delete` | Delete a doorlock key. | | `doorlock door-lock-key-index` | Get a list of doorlock keys for a specific app client and property. | | `doorlock door-lock-key-update` | Update a doorlock key. | | `doorlock door-lock-settings-delete` | Delete doorlock settings for property for specific application client. | | `doorlock door-lock-settings-single` | Get doorlock settings for property for specific application client. | | `doorlock door-lock-settings-upsert` | Upsert doorlock settings for property for specific application client. | | `events create` | Creates a new event associated with an existing group profile or without any profile association. | | `events destroy` | Deletes an event by ID or event code. This is a soft delete. | | `events list` | Returns a paginated list of events for a property. Events contain operational data and reference group profiles via profileId. | | `events note-create` | Creates a new note for a specific event. | | `events note-list` | Returns a paginated list of notes for a specific event. | | `events note-update` | Updates an existing note or archives it. | | `events show` | Returns detailed information about a specific event. | | `events update` | Updates an event. Only provided fields are updated. For profileId: omit to keep, null to clear, string to replace. | | `housekeeping 27abd48cb30106ec3251cf3baf34174c` | Housekeeping inspection list | | `integration client-connected-api-clients` | Get all connected API clients for a property | | `integration event-create` | Create a new integration event. | | `integration event-index` | Get a list of integration events for a specific property. | | `integration event-retry` | Retry an integration event. | | `integration event-update` | Update an integration event. | | `item create` | Adds items to a reservation, house account, or group profile. This endpoint supports batch operations, allowing multiple items to be posted in a single request. Each item can have associated payments… | | `item custom-index` | Get a list of custom items for a specific property. | | `market-segmentation group-create` | Create a new Market Segmentation Group. | | `market-segmentation group-delete` | Delete a Market Segmentation Group. | | `market-segmentation group-disable` | Disable a Market Segmentation Group. | | `market-segmentation group-enable` | Enable a Market Segmentation Group. | | `market-segmentation group-index` | Get a list of Market Segmentation Groups. | | `market-segmentation group-single` | Get Market Segmentation Group data. | | `market-segmentation group-update` | Update a Market Segmentation Group. | | `market-segmentation segment-create` | Create a new Market Segmentation Segment. | | `market-segmentation segment-default` | Set Market Segmentation Segment as Default. | | `market-segmentation segment-delete` | Delete a Market Segmentation Segment. | | `market-segmentation segment-disable` | Disable a Market Segmentation Segment. | | `market-segmentation segment-enable` | Enable a Market Segmentation Segment. | | `market-segmentation segment-index` | Get a list of Market Segmentation Segments. | | `market-segmentation segment-reservations` | Get a list of reservations linked to a Market Segmentation Segment. | | `market-segmentation segment-single` | Get Market Segmentation Segment data. | | `market-segmentation segment-update` | Update a Market Segmentation Segment. | | `property system-get-system` | Retrieves the property's system component versions | | `smart-policies policy-exception-create` | Create a new policy exception. | | `smart-policies policy-exception-destroy` | Delete a policy exception. | | `smart-policies policy-exception-eligible-rates` | Search eligible rate plans and base rates with conflict info. | | `smart-policies policy-exception-index` | List all policy exceptions for a property. | | `smart-policies policy-exception-partial-update` | Partially update a policy exception. | | `smart-policies policy-exception-show` | Get a single policy exception by ID. | | `smart-policies policy-exception-update` | Update an existing policy exception. | ## Bundled Skills | Skill | What it does | |-------|--------------| | `cloudbeds-quickstart` | Probe the API and learn the available subcommands. | | `cloudbeds-addons` | Addons | | `cloudbeds-amenities` | Amenities | | `cloudbeds-doorlock` | Manage doorlock | | `cloudbeds-events` | Events | | `cloudbeds-housekeeping` | Housekeeping | | `cloudbeds-integration` | Manage integration | | `cloudbeds-item` | Items | | `cloudbeds-market-segmentation` | Market Segmentation | | `cloudbeds-property` | Property | | `cloudbeds-smart-policies` | Manage smart policies | ## Data Privacy This plugin runs entirely on your machine. API calls go directly from your computer to the Cloudbeds API — no data passes through NeboAI servers. Credentials are stored locally and never leave your device.

Cloudbeds

About this plugin