Returns a list of all bookings, filtered by the specified parameters.
Returns a list of all 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: 'reservations.read, reservations.manage'.
Query parameters
Filter result by reservation id. The result set will contain all bookings having reservations with the specified id
Filter result by group id. The result set will contain all bookings having groups with the specified id
Filter result by booking id. Returns only the bookings matching the specified ids
Filter result by the channel code. The resul set will contain all bookings having reservations with the specified channel code
Filter result by the external code. The result set will contain all bookings having reservations with external code starting with provided value
This will filter all bookings for the provided free text. Currently it only looks up if either the lastname, firstname, email or company name of the booker contains one of the provided values
If set to true, returns only the bookings with an active payment account. If set to false, returns only the bookings 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: property, unitGroup, ratePlan, services, reservations. All other values will be silently ignored.
Response
OK
Example response
{
"bookings": [
{
"id": "XPGMSXGF",
"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,
"registeredCard": {
"cardNumber": "1111",
"cardHolder": "John Doe",
"expiryMonth": "8",
"expiryYear": "2018",
"paymentMethod": "visa",
"payerEmail": "s.hopper@test.com",
"note": "Credit card will be available after 2025-06-23 10:00:00",
"isVirtual": false
},
"comment": "The comment from the front desk or reservation office",
"bookerComment": "The comment from the booker provided via the booking channel",
"created": "0001-01-01T00:00:00Z",
"modified": "0001-01-01T00:00:00Z",
"reservations": [
{
"id": "XPGMSXGF-1",
"status": "Confirmed",
"externalCode": "345343345|334",
"channelCode": "BookingCom",
"hasActivePaymentAccount": false,
"arrival": "2026-09-03T17:00:00+02:00",
"departure": "2026-09-05T11:00:00+02:00",
"adults": 1,
"childrenAges": [
6
],
"totalGrossAmount": {
"amount": 130,
"currency": "EUR"
},
"property": {
"id": "MUC",
"code": "MUC",
"name": "Demo Hotel Munich",
"description": "This is the demo hotel Munich"
},
"ratePlan": {
"id": "MUC-NONREF_SGL",
"code": "NONREF",
"name": "Non Refundable",
"description": "Non Refundable",
"isSubjectToCityTax": false
},
"unitGroup": {
"id": "MUC-SGL",
"code": "SGL",
"name": "Single",
"description": "Single",
"type": "BedRoom"
},
"guestComment": "The comment from the guest provided via the booking channel",
"cancellationFee": {
"id": "MUC-FLE",
"code": "FLE",
"name": "Flexible",
"description": "Free cancellation until 36 hours before arrival.",
"dueDateTime": "2026-09-03T17:00:00+02:00",
"fee": {
"amount": 30,
"currency": "EUR"
}
},
"noShowFee": {
"id": "MUC-NONREF",
"code": "NONREF",
"name": "Non Refundable",
"description": "No free no-show",
"fee": {
"amount": 130,
"currency": "EUR"
}
},
"isPreCheckedIn": false,
"isOpenForCharges": true,
"externalReferences": {
"globalDistributionSystemId": "A2PA6WHY",
"onlineTravelAgencyId": "5247241379",
"onlineBookingToolId": "APA_HQL-C26181420|WAW-MUN-BC2-1U1",
"channelManagerId": "123295310",
"centralReservationSystemId": "91200088",
"legacyId": "988232144060772"
}
}
]
}
],
"count": 1
}Changes
No recorded changes to this endpoint across all 1 revision of this API.