Guides and Articles

Property and Group Account API Access

Suggest Edits

Cloudbeds provides API access that allows you to connect Cloudbeds to a variety of systems and build out custom workflows that are tailored to your property and the guest experience you're trying to create. Read on to understand our policies, pricing and use cases.

If you are a commercial technology company, information here doesn't apply to you. Please read our Integration Guide

Support Policies

  • Cloudbeds API is primarily a self-service feature for properties. Property developers need to work off of existing documentation.
  • The API is provided as-is to customers, meaning that Cloudbeds doesn't guarantee changes to the structure, calls/methods available, or other features. However, feature requests or improvements may be submitted to our Cloudbeds Community for consideration. We are happy to hear your ideas and plan our future developments.
  • API developers should visit our Changelog section for Regular API announcements to understand the changes made to the API and take action when needed. All breaking changes will be announced in advance and allow time for your development.
  • Bugs can be reported to Cloudbeds. Cloudbeds will do its best to develop a fix, but cannot guarantee any SLA or ETA. How to report a bug alternatively please email [email protected]
  • API access can be revoked at any point if neglectful or malicious behavior is detected. (e.g. exceeding API rate limits, attempting to circumvent security, etc).
  • Cloudbeds API is primarily a self-service tool and this article includes all relevant links to get started. Once the documentation has been analyzed, if guidance is still needed, please contact [email protected].
  • If you come across an issue that you have not been able to resolve with the documentation, articles and FAQs provided, please create a technical support ticket by emailing [email protected].

**Important: It's required that you work with highly experienced developers and use our documentation for the use case analysis.

**Once the developer has reviewed the documentation, articles and FAQ’s provided if still guidance or technical support is needed please create a support ticket by emailing [email protected]. Also note, that we do not provide telephone and/or live support, only via email. The developer should be very familiar with building to REST APIs. The developer should also ensure continuous maintenance of any apps and integrations they have developed.

API Rate Limits

  • API developers must respect our API rate limits and handle failed responses well.
  • Disrespecting API rate limits or sending too many calls due to an error will result in an immediate block from the API. Cloudbeds will block the IP address, which may affect the property's myfrontdesk account.
  • We will notify the developer or property about the block via email if possible. Developers should acknowledge the email and confirm when the fix is in place. Only then will the block be lifted. If the situation happens more than twice, you will be permanently cut off from API access.

API Authentication

**Important Note**: The user authenticating the integration via API Keys or Oath2.0 would require Cloudbeds role user access to "API and Integration" and all the sections that you're interested in integrating via the API. Our recommendation is to use an **"administrator" property user to authenticate**, this might be a property user with technical expertise, alternatively, you might consider creating a user for the developer who will be working in your dedicated integration to complete the authentication step on your behalf.

Documentation

Mandatory:

Recommended:

Enable API access

Once you have finished onboarding and familiarized yourself with the Cloudbeds application navigate to Manage > Apps & Marketplace > API Credentials.

Two scenarios will apply depending on your property package, please see full details here

  1. API Access is ready to be used as included in your package.
  2. API Access is on request and for an additional cost.

If API access is not included in your account, please, request access from your Cloudbeds account > Integrations > API Credentials and our team will discuss with you the options to add API access as an add-on or to upgrade your Cloudbeds subscription.

If you have a group account with multiple properties, and require API Acess at group organization level please send us an email to [email protected] and we'll provide the next steps.

For the purpose of API testing, you can create within your Cloudbeds account Postman credentials and an API key.

In case you require a second Cloudbeds account for testing your API integration you can contact us at [email protected] and request your test account indicating to us your property name, Cloudbeds property ID and confirmation that API access has been already granted.

Development Companies Recommended by Cloudbeds

Cloudbeds works frequently with different partners to bring solutions to market. A few of these partnerships have been so successful that we feel comfortable recommending them to our customers.

Each partner has:

  • Built multiple customer-facing products using the Cloudbeds API
  • Gained a strong understanding of the Cloudbeds API
  • Shown they can quickly understand and build great custom solutions
  • So if you are looking to build additional functionality using the Cloudbeds API, we recommend the following:

Neural Dynamics

Base Region: EMEA

"Neural Dynamics is where you get web solutions - efficiently and guaranteed. Our team specializes in creating customized web solutions and integrations for businesses, delivering quick launch and value every step of the way. We are all about clear communication, understanding your needs, and careful project management to exceed your expectations. With over 5 years of experience and more than 50 projects delivered, we are focused on creating long-lasting partnerships and turning vision into success. Let us make your project the next success story."

Mecx-Tech

Base Region: APAC

"MECX-TECH founded in 2010. We have a team of specializes in Windows app development, web development, and UX/UI design solutions for clients that provide robust API development and third-party API integration services using REST, SOAP, XML, and RPC API protocols, extending the functionality of your hotel current application with new and existing third-party systems & devices.

We are one of Cloudbeds Marketplace Partners and Solution Specialists, who are dedicated to helping hospitality businesses optimize their operations and guest services through our platform. We have a deep understanding of the hospitality industry and are well-equipped to discuss and explore potential integrations that could benefit New Inn like local payment processing."

FAQ

Can I get access to sandbox/test environment?

Yes, as indicated above you can send us a request to [email protected] indicating your property name, Cloudbeds property ID and confirmation that API access has been already granted.

Can I pass credit card information through the API?

Cloudbeds API can't be used to pass credit card data or process payments with integrated payment gateways.
It's strictly forbidden to send unencrypted payment data through the API. Numeric values longer than 12 characters and considered valid by Luhn's algorithm will be rejected.

Can I integrate my custom Booking engine via the API?

It is possible to achieve a limited booking engine integration via the API. We recommend looking at the following Booking Engine blueprint (Option 2)

How is group API access different from property API access?

  • The property API access enables access to data of only one property. No other property can use the integration.
  • The group API access enables access to data of one, multiple or all properties in the group under the same set of API credentials.
  • If the group user authorizes the connection, access token will provide data of the entire group.
  • If the property user authorizes the connection, access token will provide data of this specific property.
  • Note: Some calls will provide results for all properties in a group. These calls are tagged as "Group account support" in our API documentation.
  • At the moment, group API credentials are only available for OAuth 2.0. authentication.

Where can I see my group API access credentials?

At the moment, we don't have a dedicated page for group API credentials. We will send you your API credentials via email. Make sure to keep them safe.

If you need to change the redirect URI you should reach out to [email protected] providing us your client ID and we will do it for you.

How can I pull reports from Cloudbeds Data Insights?

Please refer to the following article Introduction to Cloudbeds Insights API

Updated 16 days ago