Returns a list of all group bookings, filtered by the specified parameters.
Returns a list of all group bookings, filtered by the specified parameters. If no parameters are set, returns the entire list<br>You must have at least one of these scopes: 'groups.read, reservations.read, reservations.manage'.
Query parameters
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
Filter result by requested properties
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>
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>
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.
Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.
Items per page. Default: 500. Maximum: 500.
List of all embedded resources that should be expanded in the response. Possible values are: blocks, actions. All other values will be silently ignored.
Response
OK
Example response
{
"groups": [
{
"id": "XPGMSXGF",
"name": "apaleo Summer Festival 2027",
"booker": {
"title": "Mr",
"gender": "Male",
"firstName": "Jon",
"middleInitial": "D",
"lastName": "Doe",
"email": "john.d@doe.com",
"phone": "+4989123343",
"address": {
"addressLine1": "My Street 5",
"postalCode": "12453",
"city": "MyCity",
"countryCode": "GB"
}
},
"paymentAccount": {
"accountNumber": "1111",
"accountHolder": "John Doe",
"expiryMonth": "8",
"expiryYear": "2018",
"paymentMethod": "visa",
"payerEmail": "s.hopper@test.com",
"isVirtual": false,
"isActive": false
},
"hasActivePaymentAccount": true,
"created": "0001-01-01T00:00:00Z",
"modified": "0001-01-01T00:00:00Z",
"blocks": [
{
"id": "MUC-JAIULS",
"status": "Definite",
"property": {
"id": "MUC",
"code": "MUC",
"name": "Demo Hotel Munich",
"description": "This is the demo hotel Munich"
},
"ratePlan": {
"id": "MUC-NONREF_DBL",
"code": "NONREF",
"name": "Non Refundable",
"description": "Non Refundable",
"isSubjectToCityTax": false
},
"unitGroup": {
"id": "MUC-DBL",
"code": "DBL",
"name": "Double",
"description": "Double",
"type": "BedRoom"
},
"marketSegment": {
"id": "CORP",
"code": "CORP",
"name": "Corporate Groups"
},
"grossDailyRate": {
"amount": 190,
"currency": "EUR"
},
"from": "2026-09-07T13:40:59.7493356+02:00",
"to": "2026-09-13T13:40:59.7493356+02:00",
"blockedUnits": 8,
"pickedReservations": 3,
"created": "2026-09-01T13:40:59.7493356+02:00",
"modified": "2026-09-01T13:40:59.7493356+02:00"
}
],
"propertyIds": [
"MUC"
]
}
],
"count": 1
}Changes
No recorded changes to this endpoint across all 1 revision of this API.