CLcloudbeds
Room

getRoomBlocks

Returns a list of all room blocks considering the informed parameters.

get/getRoomBlocks

Request

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

Query parameters

propertyIDstring

Property ID

roomBlockIDstring

Room block ID

roomTypeIDstring

Room type ID

roomIDstring

Room ID

startDatestring date

Defaults to today. Start date - will filter for any room blocks that include this date (Date range must be 35 days or less)

endDatestring date

Defaults to today. End date - will filter for any room blocks that include this date (Date range must be 35 days or less)

pageNumberinteger

Page number

pageSizeinteger

Page size

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of results returned.

totalinteger

Total number of results.

messagestring

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

Changes

No recorded changes to this operation across all 2 revisions of this API.