CLcloudbeds
Room

getRoomTypes

Changed on

Returns a list of room types filtered by the selected parameters ### Group account support

get/getRoomTypes

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getRoomTypes
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization code
      Scopes: read:room

Query parameters

propertyIDsstring

Property ID list, comma-separated, i.e. 37,345,89

roomTypeIDsstring

Room Type ID list, If more than one, send as comma-separated, i.e. 37,345,89

startDatestring date

Check-in date. Required for the rates to be returned.

endDatestring date

Check-out date. Required for the rates to be returned.

adultsinteger

Number of adults. Required for the rates to be returned.

childreninteger

Number of children. Required for the rates to be returned.

detailedRatesboolean

If detailed rates are expected

roomTypeNamestring

Room type name, used to filter

propertyCitystring

Hotel city, used to filter

propertyNamestring

Hotel name, used to filter

maxGuestsstring

Max number of guests, used to filter

pageNumberinteger

Page number

pageSizeinteger

Page size

includeArchivedboolean

Include archived inventory (removed from the property's inventory)

sortstring

Sorting rules, semicolon-separated. Format: field[:direction], where direction is asc or desc, defaults to asc if not provided. Valid fields: sorting_position. Examples: - sort=sorting_position - sort=sorting_position:desc

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results in this page

totalinteger

Total number of results

messagestring nullable

To be used in case any error occurs (if success = false). If success = true, it does not exist.

Changes

  • 6f4f997d5f7aRevision changes
    • info

      added the new optional query request parameter includeArchived

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status