Vacatia API Catalog
/
Cloudbeds API
/
Hotel

Cloudbeds API (v1.2)

Welcome to the documentation for Cloudbeds API Version v1.2! If you are looking to learn how to use the Cloudbeds API to access guest information, reservations, or similar data for your Cloudbeds customers, then you've come to the right place.

In this document you will find all the API methods we provide along with explanations for parameters and response examples.

If you have questions about different implementation steps (e.g. how to implement OAuth 2.0), please refer to our Integrations Portal.

Be sure to subscribe to the monthly Cloudbeds API announcement mailing list to receive information on new additions and improvements to the Cloudbeds API and related developer tools.

Endpoint: https://api.cloudbeds.com/api/v1.2/{method}

HTTPS: Our API requires HTTPS. We'll respond with an appropriate error if you're not using it.

Request Format: HTTP GET, POST and PUT (Content-Type: application/x-www-form-urlencoded)

Response Format: JSON

Response Header: X-Request-ID is added to response headers in all calls to help accelerate support and troubleshooting.

Run in Postman use this link to access our Public collection in Postman.

Download OpenAPI description
cloudbeds.json
cloudbeds.yaml
Languages
Servers
Mock server
https://tbg-api-docs.vacatia.com/_mock/cloudbeds/
https://api.cloudbeds.com/api/v1.2/

Authentication

Operations

Adjustment

Operations

AllotmentBlocks

Operations

AppSettings

Operations

Currency

Operations

CustomFields

Operations

Dashboard

Operations

Emails

Operations

Groups

Operations

Guest

Operations

Hotel

Operations

getHotels

Request

Returns a list of hotels, filtered by the parameters passed ### Group account support

Query
propertyIDsstring

List of property IDs, comma-separated, i.e. 37,345,89

propertyNamestring

Property name, or part of it

propertyCitystring

Property city, or part of it

pageNumberinteger

Page number

Default 1
pageSizeinteger

Page size

Default 20
curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getHotels?pageNumber=1&pageSize=20&propertyCity=string&propertyIDs=string&propertyName=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataArray of objects

Information about the hotels

countinteger

Number of results in this page

totalinteger

Total number of results

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "count": 0,
  "total": 0
}

getHotelDetails

Request

Returns the details of a specific hotel, identified by "propertyID"

Query
propertyIDstring

Property ID

curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getHotelDetails?propertyID=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataobject

Information about the hotel

Response
application/json
{
  "success": true,
  "data": {
    "propertyID": "string",
    "organizationID": "string",
    "propertyName": "string",
    "propertyType": "string",
    "propertyImage": [ … ],
    "propertyDescription": "string",
    "propertyCurrency": { … },
    "propertyPrimaryLanguage": "string",
    "propertyAdditionalPhotos": [ … ],
    "propertyPhone": "string",
    "propertyEmail": "string",
    "propertyAddress": { … },
    "propertyPolicy": { … },
    "propertyAmenities": [ … ],
    "taxID": "string",
    "taxID2": "string",
    "companyLegalName": "string"
  }
}

postFile

Request

Attaches a file to a hotel

Bodyapplication/x-www-form-urlencoded
propertyIDstring or null

Property ID

filestring(binary)

Form-based File Upload
Allowed file types: *.pdf, *.rtf, *.doc, *.docx, *.txt, *.jpg, *.jpeg, *.png, *.gif, *.csv, *.xls, *.xlsx, *.xml
Allowed max file size: 100MB

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postFile \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d propertyID=string \
  -d file=string

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

messagestring or null

To be used in case any error occurs (if success = false). If success = true, it does not exist.

dataobject

Details for the uploaded file

Response
application/json
{
  "success": true,
  "message": "string",
  "data": {
    "fileID": "string"
  }
}

getFiles

Request

Returns a list of files attached to a hotel, ordered by creation date

Query
propertyIDstring

Property ID

sortBystring

Sort By parameter

Default "date"
Enum"name""type""source""date"
orderBystring

Order response in DESCending or ASCending order, used together with sortBy

Default "desc"
Enum"desc""asc"
namestring

Filter filess by name. Include only with names containing specified string

pageNumberinteger

Results page number

Default 1
pageSizeinteger

Results page size. Max = 100

Default 100
curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getFiles?name=string&orderBy=desc&pageNumber=1&pageSize=100&propertyID=string&sortBy=name' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataArray of objects

Files linked to the property

countinteger

Number of results returned

totalinteger

Total number of results for supplied parameters

messagestring or null

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Response
application/json
{
  "success": true,
  "data": [
    { … }
  ],
  "count": 0,
  "total": 0,
  "message": "string"
}

HouseAccount

Operations

Housekeeping

Operations

Integration

Operations

Invoices

Operations

Item

Operations

Package

Operations

Payment

Operations

Rate

Operations

Reservation

Operations

Room

Operations

Taxes and Fees

Operations

User

Operations