getAllotmentBlocks

Property ID (optional, by default all authorized properties will be included)

Allotment block code

Allotment block name

GPS (Group Profile Service) external profile ID. Returns all allotment blocks linked to this GPS profile.

An event (group profile) code

Allotment block status(es)

The type of allotment block

Filters allotment blocks with the supplied Room Type ID.

Number of allotment blocks to return per page (min: 1, max: 100)

Which page in the results to access

Lower limit for the block's date range. That range includes shoulder dates, so it can begin before the earliest interval startDate. A block is returned only if its date range starts on or after this date.

Upper limit for the block's date range. That range includes shoulder dates, so it can end after the latest interval endDate. A block is returned only if its date range ends on or before this date.

If false (default) this will show the effective availability on each date. If true, will read raw availability from the allotment intervals.

When true, each block in the response will include a resources[] array with associated space resource quotes. Requires the spaces-allotment-blocks feature flag to be enabled for the property; when the flag is off, resources[] will be empty even if the param is true.

When true, each interval's availability[] also includes the interval's shoulder dates, and every availability entry carries isShoulderDate. On a shoulder date blockAllotted and blockRemaining are 0 and blockConfirmed is the number of rooms picked up against the block for that night, so it may exceed blockAllotted. Requires the property's shoulder-dates feature to be enabled; when it is off, availability[] holds only the interval's own dates even if the param is true. Has no effect when forUpdate=true: that mode reads raw interval availability, which carries no shoulder dates.