Apps and Integrations - Self-service API

Cloudbeds believes every lodging business is unique. We offer tools for all sizes and budgets to help you establish and grow your business. Reach out to our dedicated team for more information on each available package. Not yet a Cloudbeds customer? Access our Pricing Guide and schedule a demo.

What is the Self-Service API?

Getting API access allows you to access your account's data programmatically, integrate with your local systems, or build extended functionality to advance the guest experience.

API is primarily a self-service feature. You are required to work with highly experienced developers. If you still need guidance or support after your developer has reviewed and analyzed the documentation here: Property and Group Account API Access, you can email us at integrations@cloudbeds.com.

Step 1 - Getting Started

If your Cloudbeds pricing package allows you to add new API Credentials - proceed to Step 2—How to Add New Credentials.

If your Cloudbeds pricing package does not give you access to Self-Service API, then you need to submit an API Access Form:

Account->Apps & marketplace->API Credentials->Submit API Access Form:

Then select Talk to our Team and select a day and time to schedule a meeting:

Step 2 - How to Add New Credentials

1. Account ->Apps & Marketplace
2. Access API Credentials section
3. +NEW CREDENTIALS
   
4. Add a unique name for the API key set (ex. Green Parrot Website Plugin)
5. Add the Integration type
6. Redirect URI - you may enter “https://localhost” in the Redirect URI field.
7. Save
   
8. You will be presented with a modal containing Client Credentials in the form of a Client ID and Shared Secret. As these attributes are not required in the payload of an API-key enabled request, you can Close this window and ignore these parameters.
9. Select the new entry from the API Credentials table and scroll to the right to reveal the API Key column heading and click the Create button in your desired row.
   
10. Once you click the Create button, you will be presented with a list of API Scopes which you may select from. Scope selections should align with the API endpoints you plan to leverage within your integration. You can find these in the Cloudbeds API documentation.
11. Select the required scopes by checking each permission and click the Create button.
12. You will be prompted to enter your Cloudbeds login details and approve the permission scopes.