CLcloudbeds
Housekeeping

getHousekeepingStatus

Changed on

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

get/getHousekeepingStatus

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getHousekeepingStatus
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:housekeeping

Query parameters

propertyIDstring

Property ID

roomIDsstring

Filter by room ID. If more than one, send as a comma-separated list, i.e. 101-0,101-3. A room ID has the form {roomTypeID}-{index} and is the same value this endpoint returns as data.roomID. Combined with the other filters using AND. A value that is not of that form is rejected with a 400 response. A well-formed ID that matches no room of this property is not an error - it simply contributes no result. An empty value applies no room filter, so every room of the property is returned.

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.

roomCondition'clean' | 'dirty'

Condition of room

roomOccupiedboolean

Flag for current room occupation status

pageNumberinteger

Results page number

pageSizeinteger

Results page size. Max = 5000

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Results in current request

totalinteger

Total number of results for supplied parameters

messagestring nullable

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

Changes