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

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

​
Parameters

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

​
Response

​
200
{
  "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
  }
}
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