canonical: https://jentic.com/apis/hotels.cloudbeds.com/cloudbeds

# Hotels Cloudbeds Cloudbeds API

The Cloudbeds API is the property management system surface for hotels, hostels, and B&Bs - reservations, guests, rooms, rates, allotments, taxes, payments, housekeeping, and email templates live behind 115 endpoints. Cloudbeds publishes its own OpenAPI document for PMS v1.2 in its public openapi-specs repository on GitHub; the specification behind this page is a curated, agent-optimized Jentic variant covering the same 115 operations, kept validated and agent-ready. It supports both API key and OAuth 2.0 authentication, so partner integrations and single-property keys both work. Useful for booking automation, channel reconciliation, and AI hospitality assistants.

## For AI agents

Manage reservations, guests, rooms, rates, payments, and housekeeping for hotels and short-stay properties on Cloudbeds.

## Scope

Does not handle vacation rental short-term flows, accounting, or marketing email campaigns - use for hotel and B&B PMS operations on Cloudbeds only.

## Capabilities

- Create, retrieve, and modify reservations across rooms and rate plans
- Manage guest profiles, custom fields, and tax exemptions
- Adjust room rates and allotment blocks for groups and OTA channels
- Issue payments, adjustments, and refunds against a reservation folio
- Update housekeeping room status and assign cleaning tasks
- Configure email templates and scheduled guest communications
- Pull dashboard metrics for occupancy, ADR, and RevPAR reporting

## Use cases

### Front Desk Automation

Automate front-desk workflows by reading arrivals, posting payments, and updating housekeeping status from a single agent. The agent calls the dashboard endpoints to surface arrivals, posts charges via the payment endpoints, and flips room status in housekeeping when guests check out. Reduces manual click-through during shift changes.

Example prompt: Pull today's arrivals from the dashboard, then update housekeeping status for departing rooms via the housekeeping endpoints.

### OTA Channel Reconciliation

Reconcile reservations and rates between Cloudbeds and external OTA channels. The agent reads reservations and rate plans, compares against the OTA extranet, and flags mismatches for review. Helps revenue managers catch parity violations before they cost bookings.

Example prompt: Fetch all rates for the next 30 days from Cloudbeds and diff against the latest OTA pull, returning any deltas.

### Group Block Management

Manage corporate and event group blocks via the AllotmentBlocks endpoints. The agent calls createAllotmentBlock to reserve room inventory for a group, updates the block as bookings come in, and adds notes via the AllotmentBlockNotes endpoints for the front-desk team. Replaces spreadsheet tracking.

Example prompt: Create an allotment block for 25 rooms over conference dates and attach a note with the group contract reference.

### Guest Email Scheduling

Schedule pre-arrival, in-stay, and post-stay emails from Cloudbeds. The agent calls postEmailTemplate to register the message body and postEmailSchedule to attach a trigger (e.g., 24 hours before arrival). Keeps guest communications consistent across properties without separate ESP wiring.

Example prompt: Create a pre-arrival email template and schedule it to send 24 hours before each reservation's check-in date.

### AI Hotel Operations Agent via Jentic

Expose Cloudbeds' 115 endpoints to an AI hospitality agent through Jentic so it can handle reservations, payments, and housekeeping without juggling auth schemes or browsing docs. Jentic stores the API key or OAuth tokens in your Jentic One instance and surfaces operations by intent search.

Example prompt: Search Jentic for 'list today's arrivals in Cloudbeds', load the schema, and execute against the property to return arriving reservations.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/access_token` | Exchange OAuth code for access token |
| GET | `/getDashboard` | Pull property KPIs |
| GET | `/getAllotmentBlocks` | List group allotment blocks |
| POST | `/createAllotmentBlock` | Create a group allotment block |
| POST | `/postAdjustment` | Post a folio adjustment |
| POST | `/postEmailTemplate` | Create a guest email template |
| POST | `/postEmailSchedule` | Schedule a guest email |

## Key resources

- **Reservation** — Create, modify, and read guest reservations and folios.
- **Room** — Room inventory, types, and per-room status.
- **Guest** — Guest profiles, custom fields, and history.
- **Rate** — Rate plans, daily rates, and OTA-distributed pricing.
- **AllotmentBlocks** — Group and corporate inventory holds with notes.
- **Payment** — Folio payments, refunds, and adjustments.
- **Housekeeping** — Room cleaning status and task assignments.
- **Emails** — Templated guest emails and schedule triggers.
- **Dashboard** — Property KPIs including occupancy, ADR, and arrivals.

## Why Jentic

- **Setup:** Wiring Cloudbeds by hand means choosing between its x-api-key header and OAuth 2.0 auth, rotating refresh tokens yourself, and keeping the api.cloudbeds.com/api/v1.2 host straight across more than a hundred PMS endpoints. Through Jentic you install once, import the Cloudbeds API from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** With over a hundred PMS operations, scope your agent to the ones it needs, such as reading the dashboard or listing allotment blocks. You choose which calls are in the allowed set, so writes like posting adjustments or email schedules are excluded unless you add them.
- **Credential handling:** Your Cloudbeds credential is stored once, encrypted, by your own Jentic One instance, which rotates OAuth tokens at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a reservation in Cloudbeds' or 'get the property dashboard', and Jentic returns the matching Cloudbeds operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hostfully API** — Vacation rental property management focused on short-term rentals rather than hotels.
- **Booking.com API** — Distribution channel for hotels that frequently delivers reservations into Cloudbeds.
- **Stripe API** — Card processing layer for hotel deposits and on-property charges.

## FAQ

### Which OpenAPI specification does this Cloudbeds API page describe?

A curated, agent-optimized Jentic specification covering 115 Cloudbeds API operations for PMS v1.2. Cloudbeds also publishes its own OpenAPI 3.0.1 reference document at https://raw.githubusercontent.com/cloudbeds/openapi-specs/main/src/pms-v1.2-openapi.yaml, in a public repository that also carries PMS v1.3 and v2.0. The Jentic variant covers the same 115 v1.2 operations as a validated JSON document for agent tooling rather than adding coverage, so it is a curated alternative and not a silent substitute. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Cloudbeds API use?

Two options: an API key passed in a request header for single-property integrations, or OAuth 2.0 for multi-property partner apps. The /access_token endpoint exchanges an authorization code for tokens. Jentic stores credentials in your Jentic One instance.

### Can I create reservations with the Cloudbeds API?

Yes. The Reservation resource exposes create, read, modify, and cancel operations. You attach guests, room types, and rate plans to the reservation, and Cloudbeds maintains the folio that links payments and adjustments back to it.

### What are the rate limits for the Cloudbeds API?

Cloudbeds enforces per-property and per-app rate limits that scale with partnership tier. Honor 429 responses, batch reads where possible, and use webhooks for state changes rather than polling /getDashboard or reservation lists in tight loops.

### How do I post a payment to a reservation with the Cloudbeds API through Jentic?

Run pip install jentic, search for 'post payment to Cloudbeds reservation', load the appropriate Payment schema, and execute with the reservation id and amount. Jentic handles the auth header automatically.

### Can I manage group allotments with the Cloudbeds API?

Yes. Use createAllotmentBlock to set aside room inventory, getAllotmentBlocks to list active blocks, updateAllotmentBlock to adjust counts, and the AllotmentBlockNotes endpoints to attach group contract context.

### Can I limit what my agent is allowed to do with the Cloudbeds API?

Yes. Because Jentic One is self-hosted, you decide which of the more than one hundred Cloudbeds PMS operations your agent may call, and only the ones in your allowed set are exposed. You can grant read-only access such as getDashboard for property KPIs or getAllotmentBlocks to list group blocks, while write calls like postAdjustment or postEmailSchedule stay excluded until you add them. The Cloudbeds credential is stored by your own instance and never enters the agent's prompt, so your rules alone govern what it can reach.