> ## Documentation Index
> Fetch the complete documentation index at: https://docs.series.hr/llms.txt
> Use this file to discover all available pages before exploring further.

# List Rooms

> List all hotel rooms with filters and room type data

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

```bash theme={null}
curl -X GET "https://api.series.hr/hotel/list?floor=2&status=available" \
  -H "apikey: YOUR_API_KEY"
```

## Parameters

<ParamField query="floor" type="integer">
  Filter by floor number.
</ParamField>

<ParamField query="status" type="string">
  Filter by room status: available, occupied, maintenance, reserved, or blocked.
</ParamField>

<ParamField query="roomTypeId" type="string">
  Filter by room type ID.
</ParamField>

<ParamField query="roomNumber" type="string">
  Filter by room number.
</ParamField>

<ParamField query="occupant" type="string">
  Filter by occupant user ID, username, or display name.
</ParamField>

## Response

<ResponseField status={200} name="200">
  ```json theme={null}
  {
    "success": true,
    "data": {
      "WorkspaceId": "a7d5339a-5531-4336-99c6-6f3249c9ac20",
      "WorkspaceName": "Hotel Series",
      "Hotel": {
        "Description": "Luxury waterfront hotel",
        "EnableCheckInOutTimes": true,
        "CheckInTime": "14:00",
        "CheckOutTime": "11:00",
        "Reservations": {
          "Enabled": true
        },
        "TotalRooms": 42,
        "FilteredRooms": 8,
        "RoomTypes": [],
        "Rooms": []
      },
      "Filters": {
        "floor": 2,
        "status": "available",
        "roomTypeId": "deluxe-suite",
        "roomNumber": "204",
        "occupant": "714760171"
      },
      "ModuleEnabled": true
    }
  }
  ```
</ResponseField>

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