Cloudbeds API
Cloudbeds exposes a REST API (v1.3 at api.cloudbeds.com) covering properties, room types, rooms, rates, reservations, guests and webhooks, authenticated with a property or organization API key sent as x-api-key.
Written from running this integration in production. Last checked against the Cloudbeds API on 11 November 2026.
Cloudbeds API report card
From Cloudbeds's own documentation. Checked on 11 November 2026.
- Base URL / API style
https://api.cloudbeds.com/api/v1.3(PMS API). Reads are GETs with query parameters; writes are form-encoded. Separate Data Insights and Accounting APIs. source- Auth
- API key (
cbat_…) inx-api-keyor as a bearer token, with scopes approved per key, for one property or an organization. Keys expire after 30 days unused. OAuth 2.0 is an alternative. source - Rate limits
- 5 requests / second for properties, 10 / second for technology partners. Exceeding them can suspend the credentials. source
- Webhooks
- Subscribe per object and action (e.g.
reservation/created), per property, withpostWebhook. No payload signature; an optional auth header you choose. Retried once a minute, up to 5 attempts; a handler slower than 2 s counts as failed. Order not guaranteed. source - Read / write coverage
- Read properties, room types, rooms, rate plans, availability, reservations, guests, payments and room blocks. Write reservations, rates and restrictions (rate writes run as jobs), guests and payments. source
- Guest messaging
- No guest-messaging endpoints. Technology partners can create email templates and schedules that Cloudbeds sends. source
- Sandbox / test account
- Partner test account with dummy data, on request to integrations@cloudbeds.com. source
- Partner / marketplace programme
- Technology Partner programme: partnership evaluation, certification, a pilot with 5 to 10 properties. A Marketplace listing needs agreed commercial terms and a signed partnership agreement. source
- Restrictions worth knowing
- Cloudbeds’s API terms license the API “solely to develop, test and support an integration of your application” and bar using it to “substantially replicate or compete with core products or services offered by Cloudbeds” (4.4). source
What the Cloudbeds API is
Cloudbeds is a PMS for hotels, hostels and vacation rentals, with a REST API at https://api.cloudbeds.com/api/v1.3. It covers the property, room types, rooms, rate plans, availability and restrictions, reservations, guests, payments, room blocks and webhooks. Separate Data Insights and Accounting APIs serve reporting and finance.
Like Mews, it is built on the hotel model: a room type has rooms under it, and a reservation can hold several rooms, each of a different type. Repull maps a room type to a listing and each room to a unit, and splits a multi-room booking into one reservation per room.
A property can create its own API key without a partner agreement, which makes Cloudbeds quick to connect for a single property. Software companies that want to serve Cloudbeds customers go through Cloudbeds’s Technology Partner programme: a partnership evaluation, certification and a pilot with 5 to 10 properties.
Through Repull: GET /v1/listings/{id}/units lists a room type’s rooms, every reservation carries unit, and availability reports availableUnits per night. Calendar edits and bookings (POST /v1/reservations, PATCH /v1/reservations/{id}, POST /v1/reservations/{id}/cancel) are made in Cloudbeds first.
How to get Cloudbeds API access
- 1.In Cloudbeds, open Account → Apps & Marketplace → API Credentials and create credentials (name, category, and a redirect URI;
https://localhostis fine for an API key). Tick "Enable for entire organization" for one key across several properties. - 2.In the new row, choose API Key → Create, select the scopes you need, and approve them. Cloudbeds asks you to sign in again to confirm.
- 3.Copy the key when it is shown; it is not shown again. It starts with
cbat_. - 4.Send it as
x-api-key(or as a bearer token) to the API, or toPOST /v1/connect/cloudbeds/credentialsto connect it to Repull.
A key that is not used for 30 days expires. A connected property’s regular sync keeps it alive. Cloudbeds describes property-level keys as valid for testing only for technology partners, who must implement partner-level API keys before certification.
What will bite you
From running this integration in production and reading the vendor's documentation line by line.
Errors can arrive as 200
Cloudbeds often answers a refused request with HTTP 200 and { "success": false, "message": ... }. Code that trusts the status code records a failure as a success.
Rate updates are jobs, not writes
patchRate and putRate queue a job and return a job reference; the change is applied afterwards and can still fail. One request takes at most 30 intervals, derived rate plans cannot be written at all, and getRateJobs only returns jobs from the last 7 days, so check soon.
Rate limits are enforced by suspension
The limit is 5 requests per second for properties and 10 for technology partners. Exceeding it can get the credentials suspended until you tell Cloudbeds the integration is fixed, which is an outage, not a slowdown. Throttle on your side.
Webhooks: one subscription per event, per property, no signature
You subscribe each object and action separately (reservation/created, reservation/status_changed, …) with postWebhook, per property. Payloads are not signed; you pass a header name and value that Cloudbeds sends back. Re-posting an existing subscription with a header creates a second one, and the original keeps delivering without it. A handler slower than 2 seconds counts as failed and the event is sent again, retried once a minute up to five attempts, in no guaranteed order.
Writes are form-encoded with nesting
Reads are GET with query parameters; writes are application/x-www-form-urlencoded with bracketed nesting such as rooms[0][roomTypeID], and a rate interval must be an array (rates[0][interval][0][startDate]). A JSON body is not what the write endpoints expect.
Calendar reads start today, in the property’s time zone
getRate refuses a start date before the property’s today, and a property east of Greenwich is already on tomorrow while UTC is not. getRoomBlocks refuses ranges longer than 35 days.
A booking can hold several rooms
One reservation id can cover rooms of different types, each with its own dates and guest counts. The total is per booking, not per room. There is no API to hold back a number of rooms, and no guest-messaging API.
What it costs to keep working
Connecting one property is quick. The work is in the rate jobs, the webhooks and the multi-room bookings.
- •Every rate write needs a follow-up to confirm the job ran, within the 7 days the job is visible.
- •Multi-room bookings have to be split and their money apportioned consistently.
- •Webhooks are one subscription per event per property, each to create, list, rotate and delete, and a handler that must answer inside 2 seconds.
- •Unused keys expire after 30 days, so an idle connection silently stops working.
- •A request budget per key that you cannot exceed, enforced by suspension.
The same job, both ways
Cloudbeds directly
curl -s 'https://api.cloudbeds.com/api/v1.3/getReservationsWithRateDetails?pageSize=100&pageNumber=1' \
-H 'x-api-key: cbat_...'
# Subscribe each event you need, per property, with your own auth header.
curl -s -X POST 'https://api.cloudbeds.com/api/v1.3/postWebhook' \
-H 'x-api-key: cbat_...' \
--data-urlencode 'propertyID=12345' \
--data-urlencode 'object=reservation' \
--data-urlencode 'action=created' \
--data-urlencode 'endpointUrl=https://example.com/hooks/cloudbeds' \
--data-urlencode 'authHeaderName=X-Hook-Secret' \
--data-urlencode 'authHeaderValue=YOUR_SECRET'
# Then split multi-room bookings, check success:false on every 200,
# and poll getRateJobs after every price change.Through Repull
# Connect the key. Repull subscribes the property's webhooks itself.
curl -s -X POST 'https://api.repull.dev/v1/connect/cloudbeds/credentials' \
-H 'Authorization: Bearer sk_live_YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"credentials": {"apiKey": "cbat_YOUR_KEY"}}'
# One reservation per room, each naming its room type and room.
curl -s 'https://api.repull.dev/v1/reservations?limit=100' \
-H 'Authorization: Bearer sk_live_YOUR_KEY'Why use Repull for Cloudbeds
Your next property may not be on Cloudbeds
For a single Cloudbeds property, use its API key and API directly — we would be a layer you do not need. If you are a software company serving many Cloudbeds properties, talk to Cloudbeds’s partnerships team first. The cost of doing it yourself arrives with the second system.
One hotel model
Room types, rooms, room counts and assigned rooms come back the same way for Cloudbeds and Mews, and a vacation rental from Hostaway or Guesty comes back as a listing with no units, through the same calls.
Rate jobs followed to the end
A calendar write through PUT /v1/availability/{propertyId} waits for Cloudbeds’s rate job and reports what it actually applied, so you do not poll getRateJobs yourself.
Webhooks set up for you
Connecting a Cloudbeds key subscribes the reservation, guest and room-block events for each property. Your side receives Repull events with one X-Repull-Signature header to verify, the same as for every other system.
Every system authenticates differently
Cloudbeds is an API key that expires after 30 unused days. Mews is a client token plus an access token, Guesty allows five OAuth tokens a day, Hospitable tokens expire after 12 hours or a year. Repull keeps each one alive; you keep one key.
Channels next to the PMS
The same Repull key reaches Airbnb, Booking.com and Vrbo directly, and more, alongside the PMS.
Connect Cloudbeds through Repull
Create a key, connect a Cloudbeds account with the credentials Cloudbeds issues, and read reservations in the same shape as every other system you support.
Frequently asked questions
Does Cloudbeds have a public API?
Yes. The Cloudbeds API (v1.3) is documented at developers.cloudbeds.com and published as OpenAPI specs. It covers properties, room types, rooms, rates, reservations, guests, payments and webhooks. Properties can use it self-service with an API key; software companies go through the Technology Partner programme.
How do I get a Cloudbeds API key?
In Cloudbeds, go to Account → Apps & Marketplace → API Credentials, create credentials, then choose API Key → Create, select scopes and approve them. The key starts with cbat_ and is shown once.
What are the Cloudbeds API rate limits?
5 requests per second for properties and group properties, 10 per second for technology partners. Cloudbeds enforces them and may temporarily suspend credentials that exceed them, reactivating them once you confirm the integration is fixed.
Why did my Cloudbeds API key stop working?
Keys that are not used for 30 days expire. Create a new key and reconnect.
Can I message guests through the Cloudbeds API?
No. The Cloudbeds API has no guest-messaging endpoints. Technology partners can create email templates and schedules that Cloudbeds sends itself.
Does Cloudbeds have a sandbox?
Yes, for prospective partners: email integrations@cloudbeds.com with your company name, website and integration category for a test account with dummy data. A sandbox does not guarantee a Marketplace listing, which needs a partnership evaluation, agreed commercial terms and a signed agreement.
How are multi-room bookings handled?
Repull returns one reservation per room, each with its own room type, room and share of the booking’s money.
The other systems Repull connects
Reference
Auth Type
API key
Required Fields
apiKeySupported Operations
Connection Guide
In Cloudbeds, open Apps & Marketplace → API Credentials, create credentials, then create an API key and approve its scopes. Paste the key (it starts with cbat_) into Repull Connect.
Notes
- • A listing is a room type; its rooms are units
- • A booking with several rooms becomes one reservation per room
- • Writes prices, restrictions and reservations back to Cloudbeds
- • Guest messaging is not available through the Cloudbeds API
- • Additional items and taxes come as totals per booking, not itemized