---
title: "getHousekeepingStatus"
method: GET
path: "/getHousekeepingStatus"
tags: ["Housekeeping"]
---

# getHousekeepingStatus

`GET /getHousekeepingStatus`

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 parameters

- `propertyID` string
- `roomTypeIDs` string
- `housekeeperIDs` string
- `roomCondition` 'clean' | 'dirty'
- `roomOccupied` boolean
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetHousekeepingStatusResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[]
    - `date` string, date — Date for last date/time that the room condition changed
    - `roomTypeID` string — ID of the room type
    - `roomTypeName` string — Name of the room type
    - `roomID` string — ID of room
    - `roomName` string — Name of room
    - `roomCondition` 'dirty' | 'clean' — Room cleaning condition
    - `roomOccupied` boolean — Flag if room currently occupied
    - `roomBlocked` boolean — Flag if room is blocked
    - `frontdeskStatus` 'check-in' | 'check-out' | 'stayover' | 'turnover' | 'unused' — The following frontdesk statuses exist:<br /><br /> 'check-in' - There is no guest checking out, but there is a guest checking in.<br /> 'check-out' - Guest checking out today, but no guest checking in.<br /> 'stayover' - Guest is in-house, not checking out today and is staying for another night<br /> 'turnover' - Guest checking out today and another guest checking in today<br /> 'unused' - Room is not being used. There is no one there now due to check out, and no one arriving.
    - `housekeeperID` string — ID of Housekeeper
    - `housekeeper` string — Housekeeper name
    - `doNotDisturb` boolean — Flag if room as set as "Do Not Disturb"
    - `refusedService` boolean — Flag if room as set as "Refused Service"
    - `vacantPickup` boolean — Flag if room as set as "Vacant Pickup"
    - `roomComments` string — Room comments
  - `count` integer — Results in current request
  - `total` integer — Total number of results for supplied parameters
  - `message` string, nullable — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)