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

# getAvailableRoomTypes

`GET /getAvailableRoomTypes`

Returns a list of room types with availability considering the informed parameters ### Group account support

## Query parameters

- `propertyIDs` string
- `startDate` string, date, required
- `endDate` string, date, required
- `rooms` integer, required
- `adults` integer, required
- `children` integer, required
- `promoCode` string
- `detailedRates` boolean
- `includeSharedRooms` boolean
- `sort` 'room_name' | 'hotel_name' | 'room_price' | 'hotel_stars'
- `order` 'asc' | 'desc'
- `minRate` number
- `maxRate` number
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetAvailableRoomTypesResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Room Types details
    - `propertyID` string — Property ID
    - `propertyCurrency` object[] — Currency used by the property
      - `currencyCode` string — Currency identifier code
      - `currencySymbol` string — Currency symbol
      - `currencyPosition` 'before' | 'after' — Currency position
    - `propertyRooms` object[] — List of room types for the property
      - `roomTypeID` string — Room type ID
      - `roomTypeName` string — Room type name
      - `roomTypeNameShort` string — Room type short name
      - `roomTypeDescription` string — Room Type Description
      - `maxGuests` integer — Max number of guests allowed in the room type
      - `adultsIncluded` integer — Number of adults included on the basic room rate
      - `childrenIncluded` integer — Number of children included on the basic room rate
      - `roomTypePhotos` object[] — List of photos for the room type
        - `thumb` string — Thumbnail URL
        - `image` string — Full Image URL
      - `roomTypeFeatures` string[] — List of features for the room type
      - `roomRate` number — Basic rate for the room, based on the parameters provided
      - `roomRateID` string — Specific Rate ID used for the room type ID
      - `ratePlanNamePublic` string — Rate plan public name
      - `ratePlanNamePrivate` string — Rate plan private name
      - `roomsAvailable` integer — Number of rooms available, based on the parameters provided
      - `adultsExtraCharge` object[], nullable — Total extra charge for number of adults, depending on room settings (see "adultsIncluded" field). It is an associative array, where the key is the number of adults, and the value is the total extra charge when the number of adults is selected.
      - `childrenExtraCharge` object[], nullable — Total extra charge for number of children, depending on room settings (see "childrenIncluded" field). It is an associative array, where the key is the number of children, and the value is the total extra charge when the number of children is selected.
      - `roomRateDetailed` object[], nullable — Detailed information on the rates, if requested
        - `date` string, date, nullable
        - `rate` number, nullable
      - `derivedType` 'fixed' | 'percentage', nullable — type of deriving (only if current rate was derived from other one).
      - `derivedValue` number, nullable — Can be positive or negative (only if current rate was derived from other one).
      - `individualRooms` object[], nullable — Individual rooms available to be booked (if set on backend)
        - `roomID` string, nullable
        - `roomName` number, nullable
        - `dormRoomName` string, nullable — Name of the dorm room. Used for the shared dorm beds that are organized into rooms within the same room type.
  - `roomCount` integer — Number of results (room types) returned
  - `count` integer — Number of results (properties) returned
  - `total` integer — Total number of results (properties)
  - `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)