canonical: https://jentic.com/apis/cloudbeds.com/cloudbeds # Cloudbeds API Jentic publishes the only available OpenAPI specification for Cloudbeds API, keeping it validated and agent-ready. Cloudbeds is a hospitality platform that combines property management, channel management, booking engine, and payments into one system. The API exposes guests, reservations, rooms and room types, rate plans, payment methods and charges, check-in and check-out flows, notes, and OAuth lifecycle endpoints, so a partner application can read inventory, create reservations, and manage guest stays without screen-scraping the Cloudbeds UI. ## For AI agents Create reservations, manage guests, assign rooms, and process check-ins, charges, and check-outs across Cloudbeds-managed properties. ## Scope Does not handle airline bookings, third-party OTA inventory, or general payment processing - use for managing reservations and stays in Cloudbeds-managed properties only. ## Capabilities - Create and read reservations against a property's room inventory - Manage guest profiles attached to a reservation including contact details and notes - Assign and reassign rooms within a reservation before or during the stay - Drive check-in and check-out flows with the dedicated endpoints - Read available rooms, room types, and rate plans for date ranges - Record payment methods and apply charges to a reservation folio - Add operational notes to a reservation for front-desk handover ## Use cases ### Direct Booking Engine Integration Power a custom direct-booking site against Cloudbeds inventory. Read available room types and rate plans for the requested date range, then call the reservation creation endpoint to lock the booking. Cloudbeds handles inventory consistency across the channel manager, so direct bookings cannot oversell rooms that OTAs hold. Example prompt: List room-types and rates for the date range, then create a reservation for the guest with the chosen rate plan ### Front-Desk Mobile Apps Build a tablet-based front-desk app that drives arrival and departure workflows for housekeepers and receptionists. The check-in endpoint marks a guest as in-house, room assignment moves rooms when needed, and the check-out endpoint settles the folio. Notes can be added to a reservation so the next shift sees the latest guest context without paper handovers. Example prompt: Drive the check-in flow for an arrival reservation: assign room, call the checkin endpoint, then add a note with key handover details ### Folio and Payment Reconciliation Push room charges, incidental fees, and refunds to a reservation folio so accounting reflects the night's revenue. Payment method endpoints and the charge endpoint write financial events against a reservation, which is the standard pattern for integrating a third-party POS or payments service with Cloudbeds. Example prompt: POST a $25 minibar charge to the reservation folio with the recorded payment method ### Guest CRM Sync Sync guest profiles between Cloudbeds and a downstream CRM or marketing system. Guest endpoints read profiles created at booking time, and notes capture rich preferences (allergies, accessibility needs, repeat-guest history) that feed into segmentation. This keeps marketing aligned with the source-of-truth guest record in Cloudbeds. Example prompt: Read guest profiles updated in the last 24 hours and upsert them into the downstream CRM ### Agent-Driven Reservation Workflows via Jentic AI assistants for hoteliers can answer 'book the family suite for the Smith party next Friday' by searching Jentic for an intent and executing the reservation creation operation. The Cloudbeds OAuth token sits in your Jentic One instance and a scoped credential is issued per call, so the assistant never logs property credentials - important when the same agent serves multiple Cloudbeds properties. Example prompt: Search Jentic for 'create cloudbeds reservation', load the operation, and execute with guest, dates, and rate plan ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | /reservation | Create a reservation | | GET | /reservations | List reservations | | GET | /rooms | List rooms | | GET | /room-types | List room types | | POST | /charge | Charge a reservation folio | | POST | /checkin | Check a reservation in | | POST | /checkout | Check a reservation out | | POST | /note | Add a note to a reservation | ## Key resources - **reservations** — Reservation creation, retrieval, and listing - **guests** — Guest profiles attached to a reservation - **rooms** — Room and room-type inventory and assignment - **rates** — Rate plans and rate items for date ranges - **payment** — Payment methods and charges on a reservation folio - **checkin/checkout** — Arrival and departure flow endpoints - **notes** — Operational notes attached to a reservation - **oauth** — OAuth token and userinfo endpoints ## Why Jentic - **Setup:** Wiring the Cloudbeds API by hand means running its OAuth2 flow, refreshing scoped bearer tokens, and pointing property calls at api.cloudbeds.com yourself. Through Jentic you install once, import the Cloudbeds API from the API Directory, store the OAuth credential once, and your agent calls it. - **Permission scoping:** Cloudbeds identifies the property and reservation through request parameters rather than a resource id fixed in the URL path, so scope the agent by the operations it needs, such as listing rooms, reading reservations, or checking a guest in. You choose that set, so a charge or a checkout is only in reach if you include it. - **Credential handling:** Your Cloudbeds OAuth credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'create a Cloudbeds reservation' or 'check a guest in', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without navigating developers.cloudbeds.com. ## Related APIs - **Amadeus Hospitality** — Enterprise PMS and CRS for chain hotels with deep distribution coverage. - **BookingSync** — Vacation rental management platform with channel sync to OTAs. - **Amadeus Hotel Search** — GDS-side hotel search and booking for travel apps. ## FAQ ### Why is there no official OpenAPI spec for Cloudbeds API? Cloudbeds does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Cloudbeds API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer. ### What authentication does the Cloudbeds API use? Cloudbeds uses OAuth 2.0 - partner applications register with Cloudbeds, exchange an authorization grant for a token via the /access_token endpoint, then call the API with the bearer token. Through Jentic, the OAuth token sits in the vault and a scoped credential is issued per call so the raw token never enters the agent's context. ### Can I create a reservation programmatically with this API? Yes. POST /reservation accepts the guest, room type, rate plan, and date range and returns the reservation record. /room-types and /rates can be queried first to confirm availability and price for the requested window. ### What are the rate limits for the Cloudbeds API? Cloudbeds applies per-property rate limits documented in the partner reference. Treat sustained throughput as roughly a few requests per second per property and back off on 429 responses by inspecting the Retry-After header. ### How do I check a guest in through Jentic? Run pip install jentic, search for 'check guest in cloudbeds', load the POST /checkin operation, then execute with the reservation ID. The call updates the reservation status to in-house. ### Does this API expose rates and rate plans? Yes. /rate, /rates, and /rate-items endpoints expose rate plans and per-item rates for date ranges, which is the data the booking engine needs to display price for a stay before reservation creation. ### Can I limit what my agent is allowed to do with the Cloudbeds API? Yes. Jentic One is self-hosted, so you run your own instance and your own rules decide which Cloudbeds operations and credentials the agent may use. Because Cloudbeds identifies the property and reservation through request parameters rather than a fixed resource in the URL path, you scope the agent by the specific operations it needs, such as listing rooms, reading reservations, or checking a guest in. Write actions like posting a charge to a folio or running a checkout are only reachable if you include them in that set.