Group

Returns number of group bookings

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

get/booking/v1/groups/$count

Query parameters

textSearchstring

This will filter all group bookings for the provided free text. Currently it only looks up if either the group name, lastname, firstname, email or company name of the booker contains one of the provided values

propertyIdsstring[]

Filter result by requested properties

fromstring date-time

The start of the time range. All groups that have blocks 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 groups that have blocks 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>

hasActivePaymentAccountboolean

If set to true, returns only the groups with an active payment account. If set to false, returns only the groups without an active payment account.

Response

Success

countinteger required

Example response

{
  "count": 50
}

Changes

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