---
title: "getRooms"
method: GET
path: "/getRooms"
tags: ["Room"]
---

# getRooms

`GET /getRooms`

Returns a list of all rooms considering the informed parameters. If Check-in/out dates are sent, only unassigned rooms are returned. ### Group account support

## Query parameters

- `propertyIDs` string
- `roomTypeID` string
- `roomTypeNameShort` string
- `startDate` string, date
- `endDate` string, date
- `includeRoomRelations` integer
- `pageNumber` integer
- `pageSize` integer
- `sort` string

## Response `200`

200 Response

- GetRoomsResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Room Types details
    - `propertyID` string — Property ID
    - `rooms` object[] — All rooms for property ID
      - `roomID` string — Room ID
      - `roomName` string — Room Name
      - `dormRoomName` string — Name of the dorm room. Used for the shared dorm beds that are organized into rooms within the same room type
      - `roomDescription` string — Room Description
      - `maxGuests` integer — Number of guests that room allows
      - `isPrivate` boolean — If room is private (true) or shared (false)
      - `isVirtual` boolean — If room is virtual (true) or physical (false)
      - `roomBlocked` boolean — If room is blocked on calendar during the period selected. If no check-in/out dates are sent, it returns the status for the current day.
      - `roomTypeID` string — Room type ID
      - `roomTypeName` string — Room type Name
      - `roomTypeNameShort` string — Room type Short Name
      - `doorlockID` string — The doorlock ID for the room
      - `linkedRoomIDs` string[], nullable — List of linked room IDs for this room (including nested relations). Only returned if includeRoomRelations is set to true
      - `linkedRoomTypeIDs` string[], nullable — List of linked room type IDs. Only returned if includeRoomRelations is set to true
      - `linkedRoomTypeQty` object[], nullable — Data about linked rooms count, grouped by room type. Only returned if includeRoomRelations is set to true
        - `roomTypeId` string, nullable — Room type ID
        - `roomQty` integer, nullable — Related rooms count
  - `count` integer — Number of results (properties) returned
  - `total` integer — Total number of results, can be more than what was returned
  - `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)