General

1. What are your Rate Limits and API Methods Limits?

Properties and Group Properties: 5 requests per second

Tech Partners: 10 requests per second

Cloudbeds API rate limits are enforced. While we do allow for some margin of error, exceeding these limits may result in a temporary suspension of a user's API credentials. If this happens, we will notify you directly via email. Once you confirm you have adjusted your integration's rate intervals, we will then reactivate your credentials.

Regarding API Methods usage we don't have a specific limit however we recommend up to a maximum of 6/8 API calls depending on your use case, we also strongly recommend subscribing to Webhooks.

2. Is there a newsletter I can sign up to get more information?

Please visit our Changelog or Regular API announcements.

3. Can anyone connect to your API?

Our API is open to Technology Partners who wish to build to us and can offer a product to our clients. To become a technology partner tell us more here.

For Property Level API please refer to the following article. Cloudbeds API is primarily a self-service feature for properties. Property developers need to work off of existing documentation.

4. How many pilot properties can I connect?

We require a minimum of 5 pilot properties and up to 10 for the official go-live.

5. How can I test your API?

We suggest using Postman for testing and understanding the overall usage of our calls. We do offer our public API Collection of calls that can be used in Postman. See this video to get help.

Methods

1. What are the possible card types in postPayment?

Allowed values are property based. Possible strings are:: visa, master, amex, aura, diners, hiper, elo, Discover, jcb, maestro, dan, PostCard, Eurocard, union_pay, visaelectron, Bankcard, cunion, BANRICOMPRAS

2. Languages supported with postEmailTemplate?

Here is the list with their names and codes:

  • English-en
  • Brazilian Portuguese-pt-br
  • Spanish-es
  • Russian-ru
  • Ukranian-ua
  • Italian-it
  • German-de
  • French-fr
  • Estonian-ee
  • Polish-pl
  • Dutch-nl
  • Finnish-fi
  • Greek-gr
  • Japanese-jp
  • Thai-th
  • Chinese-ch
  • Hebrew-il
  • Korean-kr
  • Swedish-se
  • Norwegian-no
  • Lithuanian-lt
  • Vietnamese-vn
  • Hungarian-hu
  • Slovak-sk
  • Czech-cz
  • Romanian-ro
  • Arabic-

3. What things does your API make it possible to do?

We maintain a list of app blueprints explaining how an app could connect and use our API calls. See our Use Cases (Blueprints) for different app types.

4. Can I get pending transactions with getTransactions?

No, getTransactions provides the list of transactions already posted into myfrontdesk folio.

5. Can I get a list of all of the in-house guests/reservations for a given day, regardless of their check-in/check-out dates?

For example, if you want to see all of the guests/reservations for February 26, 2021 use these filters: checkInTo=2021-02-26&checkOutFrom=2021-02-26