v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
AllotmentBlocks

getAllotmentBlocks

Retrieve allotment blocks

get/getAllotmentBlocks

Query parameters

propertyIDstring required

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

allotmentBlockCodestring

Allotment block code

allotmentBlockNamestring

Allotment block name

groupCodestring

A group profile code

groupProfileIDstring

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

eventCodestring

An event code

allotmentBlockStatus'definite' | 'tentative' | 'lead' | 'cancelled'

Allotment block status(es)

allotmentBlockType'aggregate' | 'allotment'

The type of allotment block

roomTypeIDstring

Filters allotment blocks with the supplied Room Type ID.

pageSizeinteger

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

pageNumberinteger

Which page in the results to access

startDatestring date

Interval start date

endDatestring date

Interval end date

forUpdateboolean

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

includeResourcesboolean

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.

Response

200 Response

successboolean

Returns if the request could be completed

countinteger

Number of allotment blocks returned

totalinteger

Total number of allotment blocks