--- title: "getAllotmentBlocks" method: GET path: "/getAllotmentBlocks" tags: ["AllotmentBlocks"] --- # getAllotmentBlocks `GET /getAllotmentBlocks` Retrieve allotment blocks ## Query parameters - `propertyID` string, required - `allotmentBlockCode` string - `allotmentBlockName` string - `groupCode` string - `groupProfileID` string - `eventCode` string - `allotmentBlockStatus` 'definite' | 'tentative' | 'lead' | 'cancelled' - `allotmentBlockType` 'aggregate' | 'allotment' - `roomTypeID` string - `pageSize` integer - `pageNumber` integer - `startDate` string, date - `endDate` string, date - `forUpdate` boolean - `includeResources` boolean ## Response `200` 200 Response - GetAllotmentBlocksResponse - `success` boolean — Returns if the request could be completed - `count` integer — Number of allotment blocks returned - `total` integer — Total number of allotment blocks - `data` object[] — Allotment Blocks - `propertyID` string — Property ID associated to the allotment block - `allotmentBlockCode` string — Allotment block code - `allotmentBlockStatus` string — Allotment block status - `allotmentBlockName` string — Allotment block name - `allotmentBlockId` string — Allotment block ID - `rateType` string — Rate type for the allotment block - `ratePlanId` string — Rate plan ID if applicable - `ratePlan` string — Rate plan name if applicable - `allotmentType` string — the type of allotment block - `groupId` string — Group profile ID associated to the allotment block - `groupCode` string — Group profile code associated to the allotment block - `eventId` string — Event ID associated to the allotment block - `eventCode` string — Event code associated to the allotment block - `bookingCodeUrl` string — URL for the booking engine with the allotment block code pre-filled - `isAutoRelease` boolean — If the allotment block is configured for auto-release - `autoRelease` object[] — auto-release data if applicable - `releaseType` 'all_dates' | 'by_day' | 'by_interval' — The type of auto-release - `releaseDays` integer — The number of days prior to the end of the allotment block to begin releasing dates from the allotment block - `releaseTime` string — The hour to being the auto-release in HH:00 format, e.g. '00:00', '01:00'... - `releaseStatus` string — Current status of the inventory release process - `releaseScheduleStatus` string — Human-readable description of release schedule - `releaseScheduleType` string — The release scheduling method for inventory release - `releaseDate` string — Release date - `reservationsCount` integer — Number of linked reservations - `roomsHeld` integer — Total rooms held - `roomsPickedUp` integer — Rooms picked up - `roomsRemaining` integer — Rooms remaining - `allotmentIntervals` object[] — array of interval data by room type - `policyId` string — Policy ID associated with the interval - `roomTypeId` string — Room type ID - `startDate` string, date — Interval start date - `endDate` string, date — Interval end date - `availability` object[] — Interval availability data by day in interval - `date` string, date — Day within interval - `blockRemaining` integer — Number of units remaining for the room type for this day - `blockAllotted` integer — Total number of units available for the room type for this day. Note: this value is ignored for based_on_availability allotment types, which always use full property availability. - `blockConfirmed` integer — Number of units booked for the room type for this day - `rate` string — the price - `guestPricing` object — Guest pricing data if applicable. Note: the number of results varies here based on the occupancy settings and custom guest pricing for the room type. - `adult1` string — Price for adult 1 - `adult2` string — Price for adult 2 - `adult3` string — Price for adult 3 - `child1` string — Price for child 1 - `child2` string — Price for child 2 - `child3` string — Price for child 3 - `splitBlockAllotted` integer — Number of split units available for the room type this day - `splitBlockConfirmed` integer — Number of split units blocked for the room type this day - `restrictions` object — Interval restrictions if applicable - `minLos` integer — Minimum length of stay requirement - `maxLos` integer — Maximum length of stay requirement - `cutOffDays` integer — How many days before arrival should guests be required to book - `lastMinuteBookingDays` integer — How many days before the arrival guests are allowed to book - `closedToArrival` integer — If the interval dates are closed for arrival - `closedToDeparture` integer — If the interval dates are closed for departure - `splitInventory` boolean, nullable — Whether split inventory is enabled for this room type. When true, the linked physical room types are individually bookable within the allotment block, with their availability drawn from the allotment capacity of this room type. - `shoulderDatesBefore` integer, nullable — Number of shoulder days before the event start date. - `shoulderDatesAfter` integer, nullable — Number of shoulder days after the event end date. - `shoulderDatesRateId` string, nullable — Rate plan ID applied during shoulder date periods. - `resources` object[], nullable — Space resource quotes (present when includeResources=true) - `id` string — Resource quote ID - `resourceTypeId` string — Resource type ID - `resourceId` string, nullable — Resource ID (null for quantity-based) - `resourceTypeQuantity` integer, nullable — Quantity of resources - `startAt` string — Start date-time (ISO-8601) - `endAt` string — End date-time (ISO-8601) - `intervalRate` integer, nullable — Rate in cents (e.g. 15000 = $150.00) - `intervalType` 'per_interval' | 'per_rental', nullable — Interval type - `confirmed` boolean — Whether the resource quote is confirmed - `adults` integer — Number of adults - `children` integer — Number of children - `inventoryStrategy` string, nullable — Inventory strategy (RESERVATION or ALLOTMENT) - `allotmentQuantityTotal` integer, nullable — Total allotment quantity - `allotmentQuantityConsumed` integer, nullable — Consumed allotment quantity - `resourceType` object, nullable — Resource type details - `resource` object, nullable — Resource details - `title` string, nullable — Title of the resource quote - `notes` string, nullable — Notes for the resource quote - `eventIntervalPeriod` string, nullable — Event interval period (minute/hour/day/week/month/year) - `eventIntervalAmount` integer, nullable — Event interval amount - `intervalQuantity` integer, nullable — Interval quantity - `currencyCode` string, nullable — Currency code - `netAmount` object, nullable — Net amount (amount + currencyCode) - `subtotal` object, nullable — Subtotal amount - `inclusiveTaxesAndFeesAmount` object, nullable — Inclusive taxes and fees amount - `exclusiveTaxesAndFeesAmount` object, nullable — Exclusive taxes and fees amount - `total` object, nullable — Total amount - `taxes` object[] — Applied taxes - `fees` object[] — Applied fees --- [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/versions/2faa857793e8/schema)