Sign in
Block

Returns number of blocks

Returns number of blocks matching the filter criteria<br>You must have at least one of these scopes: 'blocks.read, reservations.read, reservations.manage'.

get/booking/v1/blocks/$count

Query parameters

groupIdstring

Return blocks for the specific group

propertyIdsstring[]

Return blocks filtered by properties

statusstring[]

Return blocks filtered by statuses

unitGroupIdsstring[]

Return blocks with any of the specified unit groups

ratePlanIdsstring[]

Return blocks with any of the specified rate plans

timeSliceDefinitionIdsstring[]

Return blocks with any of the specified time slice definitions

unitGroupTypesstring[]

Return blocks with any of the specified unit group types

timeSliceTemplate'DayUse' | 'OverNight'

The time slice template, defaults to 'over night'

fromstring date-time

The start of the time range. All blocks that are overlapping with the interval specified by from and to will be returned<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

tostring date-time

The end of the time range. All blocks that are overlapping with the interval specified by from and to will be returned<br />A date and time (without fractional second part) in UTC or with UTC offset as defined in <a href="https://en.wikipedia.org/wiki/ISO_8601">ISO8601:2004</a>

Response

Success

countinteger required

Example response

{
  "count": 50
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.