Skip to main content
List every room in the workspace hotel inventory, with its room type embedded and optional filters for floor, status, room type, room number, and occupant.

Request

Parameters

integer
Filter by floor number.
string
Filter by room status: available, occupied, maintenance, reserved, or blocked.
string
Filter by room type ID.
string
Filter by room number.
string
Filter by occupant user ID, username, or display name.

Response

Each room in Hotel.Rooms includes its room type as RoomType.

Status Codes

  • 200: Rooms returned successfully
  • 401: API key is required or invalid
  • 403: Hotel module is disabled or workspace access is denied