Sign in
Reservation

Returns a list of all reservations, filtered by the specified parameters.

Returns a list of all reservations, 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'.

get/booking/v1/reservations

Query parameters

bookingIdstring

Filter result by booking id

propertyIdsstring[]

Filter result by requested properties

ratePlanIdsstring[]

Filter result by requested rate plans

companyIdsstring[]

Filter result by requested companies

unitIdsstring[]

Filter result by assigned units

unitGroupIdsstring[]

Filter result by requested unit groups

unitGroupTypesstring[]

Filter result by requested unit group types

blockIdsstring[]

Filter result by requested blocks

marketSegmentIdsstring[]

Filter result by requested market segments

statusstring[]

Filter result by reservation status

dateFilter'Arrival' | 'Departure' | 'Stay' | 'Creation' | 'Modification' | 'Cancellation' | 'ArrivalAndCheckIn' | 'DepartureAndCheckOut'

Filter by date and time attributes of reservation. Use in combination with the 'To' and 'From' attributes. All filters will check if the date specified by the filter type is between from (included) and to (excluded). The exception being filtering for 'stay', which will return all reservations that are overlapping with the interval specified by from and to.

fromstring date-time

The start of the time interval. When filtering by date, at least one of 'from' and 'to' has to be specified<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 interval, must be larger than 'from'. When filtering by date, at least one of 'from' and 'to' has to be specified<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>

channelCodestring[]

Filter result by the channel code

sourcesstring[]

Filter result by source

validationMessageCategorystring[]

Filter result by validation message category

externalCodestring

Filter result by the external code. The result set will contain all reservations that have an external code starting with the provided value

textSearchstring

Filters reservations by searching for the provided text across multiple fields. The search is case-insensitive and includes:

  • Booker information (first name, last name, email, company name)
  • Primary guest information (first name, last name, email, company name)
  • Additional guest information (first name, last name, email, company name)
  • Reservation details (external code, external references, reservation ID)
  • Unit name
  • Group name
balanceFilterstring[]

This will filter reservations based on their balance.<br />You can provide an array of string expressions which all need to apply.<br />Each expression has the form of 'OPERATION_VALUE' where VALUE needs to be of the valid format of the property type and OPERATION can be:<br />'eq' for equals<br />'neq' for not equals<br />'lt' for less than<br />'gt' for greater than<br />'lte' for less than or equals<br />'gte' for greater than or equals<br />For instance<br />'eq_5' would mean the value should equal 5<br />'lte_7' would mean the value should be less than or equal to 7

allFoliosHaveInvoiceboolean

If set to true, returns only reservations, in which all folios are closed and have an invoice. If set to false, returns only reservations, in which some of the folios are open or don't have an invoice

isPreCheckedInboolean

If set to true, returns only the reservations marked as pre-checked-in. If set to false, returns only the reservations not marked as pre-checked-in.

hasActivePaymentAccountboolean

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

externalReferencesstring[]

This will filter all reservation where the provided external references have an exact match on at least one of the properties in Apaleo.Api.Modules.Booking.Models.Reservation.ExternalReferencesModel

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

sortstring[]

List of all fields that can be used to sort the results. Possible values are: arrival:asc, arrival:desc, departure:asc, departure:desc, created:asc, created:desc, updated:asc, updated:desc, balance:asc, balance:desc, id:asc, id:desc, firstname:asc, firstname:desc, lastname:asc, lastname:desc, unitname:asc, unitname:desc. All other values will be silently ignored.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: booker, actions, timeSlices, services, assignedUnits, company. All other values will be silently ignored.

Response

OK

countinteger required

Total count of items

Example response

{
  "reservations": [
    {
      "id": "XPGMSXGF-1",
      "bookingId": "XPGMSXGF",
      "status": "Confirmed",
      "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"
      },
      "unit": {
        "id": "MUC-MTA",
        "name": "A.101",
        "description": "Single room",
        "unitGroupId": "MUC-SGL"
      },
      "totalGrossAmount": {
        "amount": 110,
        "currency": "EUR"
      },
      "arrival": "2026-09-03T17:00:00+02:00",
      "departure": "2026-09-05T11:00:00+02:00",
      "created": "2026-09-01T13:40:59.7493356+02:00",
      "modified": "2026-09-01T13:40:59.7493356+02:00",
      "adults": 1,
      "channelCode": "Direct",
      "primaryGuest": {
        "title": "Mr",
        "gender": "Male",
        "firstName": "Jon",
        "middleInitial": "D",
        "lastName": "Doe",
        "email": "john.d@doe.com",
        "phone": "+4989123343",
        "address": {
          "addressLine1": "My Street 3",
          "postalCode": "12453",
          "city": "MyCity",
          "countryCode": "GB"
        },
        "vehicleRegistration": {
          "number": "APA322",
          "countryCode": "DE"
        }
      },
      "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
      },
      "guaranteeType": "CreditCard",
      "cancellationFee": {
        "id": "MUC-NONREF",
        "code": "NONREF",
        "name": "Non Refundable",
        "description": "100% of the accommodation.",
        "dueDateTime": "2026-09-01T13:40:59.7493356+02:00",
        "fee": {
          "amount": 110,
          "currency": "EUR"
        }
      },
      "noShowFee": {
        "id": "MUC-NOSHOW",
        "code": "NOSHOW",
        "name": "Non Refundable",
        "description": "No free no-show",
        "fee": {
          "amount": 110,
          "currency": "EUR"
        }
      },
      "balance": {
        "amount": -110,
        "currency": "EUR"
      },
      "timeSlices": [
        {
          "from": "2026-09-03T17:00:00+02:00",
          "to": "2026-09-04T17:00:00+02:00",
          "serviceDate": "2026-09-03",
          "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"
          },
          "unit": {
            "id": "MUC-MTA",
            "name": "A.101",
            "description": "Single room",
            "unitGroupId": "MUC-SGL"
          },
          "baseAmount": {
            "grossAmount": 65,
            "netAmount": 60.75,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 86,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-BRKF",
                "code": "BRKF",
                "name": "Breakfast",
                "description": "Best breakfast on this side of the Weißwurstäquator."
              },
              "serviceDate": "2026-09-03",
              "count": 0,
              "amount": {
                "grossAmount": 9.99,
                "netAmount": 8.39,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "bookedAsExtra": false
            }
          ]
        }
      ],
      "company": {
        "id": "MUC-UMBRELLA",
        "code": "UMBRELLA",
        "name": "Umbrella Corp.",
        "canCheckOutOnAr": false
      },
      "corporateCode": "UMBRELLA-DBL",
      "allFoliosHaveInvoice": false,
      "hasCityTax": false,
      "isPreCheckedIn": false,
      "isOpenForCharges": true,
      "externalReferences": {
        "globalDistributionSystemId": "A2PA6WHY",
        "onlineTravelAgencyId": "5247241379",
        "onlineBookingToolId": "APA_HQL-C26181420|WAW-MUN-BC2-1U1",
        "channelManagerId": "123295310",
        "centralReservationSystemId": "91200088",
        "legacyId": "988232144060772"
      },
      "isUnitAssignmentLocked": false
    },
    {
      "id": "APFDRQSX-1",
      "bookingId": "APFDRQSX",
      "status": "CheckedOut",
      "property": {
        "id": "MUC",
        "code": "MUC",
        "name": "Demo Hotel Munich",
        "description": "This is the demo hotel Munich"
      },
      "ratePlan": {
        "id": "MUC-FLEX_DBL",
        "code": "FLEX",
        "name": "Flexible",
        "description": "Flexible",
        "isSubjectToCityTax": false
      },
      "unitGroup": {
        "id": "MUC-DBL",
        "code": "DBL",
        "name": "Double",
        "description": "Double",
        "type": "BedRoom"
      },
      "unit": {
        "id": "MUC-JQI",
        "name": "A.102",
        "description": "Double room",
        "unitGroupId": "MUC-DBL"
      },
      "totalGrossAmount": {
        "amount": 120,
        "currency": "EUR"
      },
      "arrival": "2026-09-06T13:40:59.7493356+02:00",
      "departure": "2026-09-08T13:40:59.7493356+02:00",
      "created": "2026-09-01T13:40:59.7493356+02:00",
      "modified": "2026-09-01T13:40:59.7493356+02:00",
      "adults": 1,
      "childrenAges": [
        6
      ],
      "channelCode": "Direct",
      "primaryGuest": {
        "title": "Ms",
        "gender": "Female",
        "firstName": "Jane",
        "middleInitial": "D",
        "lastName": "Doe",
        "email": "jane.d@doe.com",
        "phone": "+4989123789",
        "address": {
          "addressLine1": "My Street 5",
          "postalCode": "12453",
          "city": "MyCity",
          "countryCode": "GB"
        },
        "vehicleRegistration": {
          "number": "APA322",
          "countryCode": "DE"
        }
      },
      "hasActivePaymentAccount": false,
      "guaranteeType": "CreditCard",
      "cancellationFee": {
        "id": "MUC-FLEX",
        "code": "FLEX",
        "name": "Flexible",
        "description": "Free cancellation.",
        "dueDateTime": "2026-09-03T17:00:00+02:00",
        "fee": {
          "amount": 120,
          "currency": "EUR"
        }
      },
      "noShowFee": {
        "id": "MUC-NOSHOW",
        "code": "NOSHOW",
        "name": "Non Refundable",
        "description": "No free no-show",
        "fee": {
          "amount": 120,
          "currency": "EUR"
        }
      },
      "balance": {
        "amount": -120,
        "currency": "EUR"
      },
      "timeSlices": [
        {
          "from": "2026-09-06T13:40:59.7493356+02:00",
          "to": "2026-09-07T13:40:59.7493356+02:00",
          "serviceDate": "2026-09-06",
          "ratePlan": {
            "id": "MUC-FLEX_DBL",
            "code": "FLEX",
            "name": "Flexible",
            "description": "Flexible",
            "isSubjectToCityTax": false
          },
          "unitGroup": {
            "id": "MUC-DBL",
            "code": "DBL",
            "name": "Double",
            "description": "Double",
            "type": "BedRoom"
          },
          "unit": {
            "id": "MUC-JQI",
            "name": "A.102",
            "description": "Double room",
            "unitGroupId": "MUC-DBL"
          },
          "baseAmount": {
            "grossAmount": 65,
            "netAmount": 60.75,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 86,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-BRKF",
                "code": "BRKF",
                "name": "Breakfast",
                "description": "Best breakfast on this side of the Weißwurstäquator."
              },
              "serviceDate": "2026-09-06",
              "count": 0,
              "amount": {
                "grossAmount": 9.99,
                "netAmount": 8.39,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "bookedAsExtra": false
            }
          ]
        },
        {
          "from": "2026-09-07T13:40:59.7493356+02:00",
          "to": "2026-09-08T13:40:59.7493356+02:00",
          "serviceDate": "2026-09-07",
          "ratePlan": {
            "id": "MUC-FLEX_DBL",
            "code": "FLEX",
            "name": "Flexible",
            "description": "Flexible",
            "isSubjectToCityTax": false
          },
          "unitGroup": {
            "id": "MUC-DBL",
            "code": "DBL",
            "name": "Double",
            "description": "Double",
            "type": "BedRoom"
          },
          "unit": {
            "id": "MUC-JQI",
            "name": "A.102",
            "description": "Double room",
            "unitGroupId": "MUC-DBL"
          },
          "baseAmount": {
            "grossAmount": 65,
            "netAmount": 60.75,
            "vatType": "Reduced",
            "vatPercent": 7,
            "currency": "EUR"
          },
          "totalGrossAmount": {
            "amount": 86,
            "currency": "EUR"
          },
          "includedServices": [
            {
              "service": {
                "id": "MUC-BRKF",
                "code": "BRKF",
                "name": "Breakfast",
                "description": "Best breakfast on this side of the Weißwurstäquator."
              },
              "serviceDate": "2026-09-07",
              "count": 0,
              "amount": {
                "grossAmount": 9.99,
                "netAmount": 8.39,
                "vatType": "Normal",
                "vatPercent": 19,
                "currency": "EUR"
              },
              "bookedAsExtra": false
            }
          ]
        }
      ],
      "validationMessages": [
        {
          "category": "OfferNotAvailable",
          "code": "RatePlanRestrictionsViolated",
          "message": "The restrictions of the rate plan are not considered"
        }
      ],
      "allFoliosHaveInvoice": false,
      "hasCityTax": true,
      "commission": {
        "commissionAmount": {
          "amount": 10,
          "currency": "EUR"
        },
        "beforeCommissionAmount": {
          "amount": 100,
          "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"
      },
      "isUnitAssignmentLocked": false
    }
  ],
  "count": 0
}

Changes

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