Vacatia API Catalog
/
Cloudbeds API
/
HouseAccount
/
getHouseAccountDetails

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

HouseAccount

Operations

getHouseAccountList

Request

Pulls list of active house accounts

Query
propertyIDstring

Property ID

curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getHouseAccountList?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

dataArray of objects

Details for the house accounts

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

getHouseAccountDetails

Request

Pulls details of specific house account

Query
propertyIDstring

Property ID

houseAccountIDstringrequired

House Account ID to get details for

resultsFromstring(date)

date"] Inferior limit date, used to filter result records

Default "current"
resultsTostring(date)

date"] Inferior limit date, used to filter result records

Default "current"
curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getHouseAccountDetails?houseAccountID=string&propertyID=string&resultsFrom=current&resultsTo=current' \
  -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

Includes records list for House Account and summary info covering the date range specified

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

postNewHouseAccount

Request

Add a new House Account

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

Property ID

accountNamestring

House Account name

isPrivateboolean or null

Whether House Account is available only to user

Default false
curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postNewHouseAccount \
  -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 accountName=string \
  -d isPrivate=false

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataobject

House Account details

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": {
    "houseAccountID": "string"
  },
  "message": "string"
}

putHouseAccountStatus

Request

Change specific house account to either open or closed.

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

Property ID

houseAccountIDstring

House Account ID

statusstring

House Account status

Enum"open""closed"
curl -i -X PUT \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/putHouseAccountStatus \
  -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 houseAccountID=string \
  -d status=open

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.

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

Housekeeping

Operations

Integration

Operations

Invoices

Operations

Item

Operations

Package

Operations

Payment

Operations

Rate

Operations

Reservation

Operations

Room

Operations

Taxes and Fees

Operations

User

Operations