Read a room's housekeeping state

Whether a room is ready for the next guest. This is where every
unit.ready and unit.dirty event's data.url points.

Reads any room of the property — including rooms that are not
published or not sold through this API — unlike GET /units/{unit},
which only sees the public catalogue. A lock or housekeeping
integration can hold this scope without units:read.

ready is true when the room is clean; an inspected room is
always ready. When the hotel requires inspection, a clean room is
not ready until it is inspected.

A single-room unit answers housekeeping and an empty
inventories. A Room Type answers housekeeping: null and one
entry per physical room in inventories; a Room Type with no
per-room inventory answers housekeeping: null and inventories: [].

Answers 404 for a room that does not exist and for one of another
property, identically.

Scope: housekeeping:read · Property-bound

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
Headers
uuid

Which property this call acts on.

Required when your key covers more than one property; omitting it
is 422 PROPERTY_NOT_IDENTIFIED.

Omit it when your key covers exactly one — it is inferred, and
sending a different id is 404.

When to send it and what each scope unlocks: Alcances y el header X-Property.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json