getAllotmentBlocks

get

https://api.cloudbeds.com/api/v1.3/getAllotmentBlocks

Retrieve allotment blocks

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

propertyID

string

required

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

allotmentBlockCode

string

Allotment block code

allotmentBlockName

string

Allotment block name

groupCode

string

A group profile code

groupProfileID

string

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

eventCode

string

An event code

allotmentBlockStatus

string

enum

Allotment block status(es)

Allowed:

allotmentBlockType

string

enum

The type of allotment block

Allowed:

roomTypeID

string

Filters allotment blocks with the supplied Room Type ID.

pageSize

integer

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

pageNumber

integer

Which page in the results to access

startDate

date

Interval start date

endDate

date

Interval end date

forUpdate

boolean

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

includeResources

boolean

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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200 Response