Vacatia API Catalog
/
Cloudbeds API
/
Housekeeping

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

Housekeeping

Operations

getHousekeepingStatus

Request

Returns the current date's housekeeping information The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true

Query
propertyIDstring

Property ID

roomTypeIDsstring

Filter by room type ID. If more than one, send as comma-separated, i.e. 37,345,89

housekeeperIDsstring

Use this parameter to filter by housekeeper. If you need to specify multiple housekeepers, send their IDs as a comma-separated list (e.g., 37, 345, 89). To retrieve unassigned housekeepers, use the value 0.

roomConditionstring

Condition of room

Enum"clean""dirty"
roomOccupiedboolean

Flag for current room occupation status

pageNumberinteger

Results page number

Default 1
pageSizeinteger

Results page size. Max = 5000

Default 100
curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getHousekeepingStatus?housekeeperIDs=string&pageNumber=1&pageSize=100&propertyID=string&roomCondition=clean&roomOccupied=true&roomTypeIDs=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
countinteger

Results in current request

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"
}

postHousekeepingStatus

Request

Switches the current date's housekeeping status for a specific room ID to either clean or dirty The housekeeping status is calculated basing on the set of fields roomOccupied | roomCondition | roomBlocked | vacantPickup | roomBlocked | refusedService The available statuses are: - Vacant and Dirty (VD): false | “dirty” | false | false | false | false - Occupied and Dirty (OD): true | “dirty” | false | false | false | false - Vacant and Clean (VC): false | “clean” | false | false | false | false - Occupied and Clean (OC): true | “clean” | false | false | false | false - Occupied and Clean Inspected (OCI): true | “inspected” | false | false | false | false - Vacant and Clean Inspected (VCI): false | “inspected” | false | false | false | false - Do Not Disturb (DND): if doNotDisturb is true - Refused Service (RS): if refusedService is true - Out of Order (OOO): if roomBlocked is true - Vacant and Pickup (VP): if vacantPickup is true

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

Property ID

roomIDstring

Room ID

roomConditionstring or null

New room condition. If no optional parameters are sent, will switch from current room condition

Enum"dirty""clean"
doNotDisturbboolean or null

New "do not disturb" status

roomCommentsstring or null

New room comments.

refusedServiceboolean or null

New "refused service" status

vacantPickupboolean or null

New "vacant_pickup" status

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postHousekeepingStatus \
  -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 roomID=string \
  -d roomCondition=dirty \
  -d doNotDisturb=true \
  -d roomComments=string \
  -d refusedService=true \
  -d vacantPickup=true

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

dataobject
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": {
    "date": "2019-08-24",
    "roomID": "string",
    "roomCondition": "dirty",
    "roomComments": "string",
    "doNotDisturb": true,
    "refusedService": true,
    "vacantPickup": true
  },
  "message": "string"
}

postHousekeeper

Request

Add New Housekeeper

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

Property ID

namestring

Housekeeper name

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postHousekeeper \
  -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 name=string

Responses

200 Response

Bodyapplication/json
successboolean

Returns if the request could be completed

housekeeperIDstring or null

Housekeeper ID. Returned if success = true.

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

putHousekeeper

Request

Edit Housekeeper Details

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

Property ID

namestring

Housekeeper name

housekeeperIDstring

Housekeeper ID

curl -i -X PUT \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/putHousekeeper \
  -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 name=string \
  -d housekeeperID=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.

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

getHousekeepers

Request

Returns a list of housekeepers ### Group account support

Query
propertyIDstring

ID for the properties to be queried (comma-separated, i.e. 37,345,89). It can be omitted if the API key is single-property, or to get results from all properties on an association.

pageNumberinteger

Results page number

Default 1
pageSizeinteger

Results page size. Max = 1000

Default 100
curl -i -X GET \
  'https://tbg-api-docs.vacatia.com/_mock/cloudbeds/getHousekeepers?pageNumber=1&pageSize=100&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
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": [
    { … }
  ],
  "message": "string"
}

postHousekeepingAssignment

Request

Assign rooms (single or multiple) to an existing housekeeper

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

Property ID

roomIDsstring

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

housekeeperIDstring

Housekeeper ID. To designate a room as unassigned, simply set the value to 0.

curl -i -X POST \
  https://tbg-api-docs.vacatia.com/_mock/cloudbeds/postHousekeepingAssignment \
  -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 roomIDs=string \
  -d housekeeperID=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.

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

Integration

Operations

Invoices

Operations

Item

Operations

Package

Operations

Payment

Operations

Rate

Operations

Reservation

Operations

Room

Operations

Taxes and Fees

Operations

User

Operations