---
title: "getRoomBlocks"
method: GET
path: "/getRoomBlocks"
tags: ["Room"]
---

# getRoomBlocks

`GET /getRoomBlocks`

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

## Query parameters

- `propertyID` string
- `roomBlockID` string
- `roomTypeID` string
- `roomID` string
- `startDate` string, date
- `endDate` string, date
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetRoomBlocksResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object — Property room block details
    - `propertyID` string — Property ID
    - `roomBlocks` object[] — Room blocks for the property
      - `roomBlockID` string — Room block ID
      - `roomBlockType` 'blocked_dates' | 'out_of_service' | 'courtesy_hold' — Room block type. ‘blocked_dates’ - Room block. ‘out_of_service’ - Out of service block. ‘courtesy_hold’ - Courtesy hold block.
      - `roomBlockReason` string — Room block reason
      - `startDate` string, date — Room block start date
      - `endDate` string, date — Room block end date
      - `rooms` object[] — All rooms for Block ID. For properties using split inventory, this includes both source rooms (explicitly requested) and linked rooms (automatically added based on shared inventory configuration).
        - `eventID` string — Event ID (unique identifier for this specific room’s block entry)
        - `roomID` string — Room ID
        - `roomTypeID` union — Room type ID
          - string
          - number
        - `isSource` boolean — Indicates whether this room was explicitly requested (true) or automatically added due to split inventory configuration (false). Auto-added rooms cannot be individually removed or swapped; they are managed through their source room.
        - `sourceEventIds` string[], nullable — Event IDs of source events that triggered this auto-added room. Null for source rooms. Present only for properties using split inventory.
        - `linkedEventIds` string[], nullable — Event IDs of auto-added rooms triggered by this source room. Null for auto-added rooms. Present only for properties using split inventory.
  - `count` integer — Number of results returned.
  - `total` integer — Total number of results.
  - `message` string — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)