CLcloudbeds
Room

getRooms

Changed on

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

get/getRooms

Request

  • Base URL
    https://api.cloudbeds.com/api/v1.3
  • URL
    https://api.cloudbeds.com/api/v1.3/getRooms
  • 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

roomTypeIDstring

Room type ID, comma-separated, i.e. 37,345,89

roomTypeNameShortstring

Room Type (short-version)

startDatestring date

Initial stay date. If sent, only returns unassigned rooms in this period. If not sent, will return all rooms available in property. Necessary if endDate is sent.

endDatestring date

Final stay date. Necessary if startDate is sent.

includeRoomRelationsinteger

Determines whether room relations info should be included in the response

pageNumberinteger

Page number

pageSizeinteger

Page size

includeArchivedboolean

Include archived units unless startDate/endDate are sent; live rows get archivedAt=null

sortstring

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

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results (properties) returned

totalinteger

Total number of results, can be more than what was returned

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