CLcloudbeds
Room

getRoomsUnassigned

Changed on

Returns a list of unassigned rooms in the property. Call is alias of getRooms. Please check its documentation for parameters, response and example. ### Group account support

get/getRoomsUnassigned

Request

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

Query parameters

propertyIDsstring

List of property IDs, comma-separated, i.e. 37,345,89

includeArchivedboolean

Archived units are never returned (dates always apply); opted-in live rows get archivedAt=null

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