getRooms

get

https://api.cloudbeds.com/api/v1.3/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 Params

propertyIDs

string

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

roomTypeID

string

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

roomTypeNameShort

string

Room Type (short-version)

startDate

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.

endDate

date

Final stay date. Necessary if startDate is sent.

includeRoomRelations

integer

Defaults to 0

Determines whether room relations info should be included in the response

pageNumber

integer

Defaults to 1

Page number

pageSize

integer

Defaults to 20

Page size

sort

string

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

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response