---
title: "getReservations"
method: GET
path: "/getReservations"
tags: ["Reservation"]
---

# getReservations

`GET /getReservations`

Returns a list of reservations that matched the filters criteria.<br /> Please note that some reservations modification may not be reflected in this timestamp. ### Group account support

## Query parameters

- `propertyID` string
- `status` 'not_confirmed' | 'confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show'
- `resultsFrom` string, date-time
- `resultsTo` string, date-time
- `modifiedFrom` string, date-time
- `modifiedTo` string, date-time
- `checkInFrom` string, date
- `checkInTo` string, date
- `checkOutFrom` string, date
- `checkOutTo` string, date
- `datesQueryMode` 'booking' | 'rooms'
- `roomID` string
- `roomName` string
- `roomTypeID` string
- `includeGuestsDetails` boolean
- `includeGuestRequirements` boolean
- `includeCustomFields` boolean
- `includeAllRooms` boolean
- `sourceId` string
- `sourceReservationId` string
- `ratePlanId` string
- `firstName` string
- `lastName` string
- `guestID` string
- `allotmentBlockCode` string
- `groupCode` string
- `sortByRecent` boolean
- `pageNumber` integer
- `pageSize` integer

## Response `200`

200 Response

- GetReservationsResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object[] — Details for the reservation queried
    - `propertyID` string — Properties identifier
    - `reservationID` string — Reservation's unique identifier
    - `dateCreated` string, date-time
    - `dateModified` string, date-time
    - `status` 'not_confirmed' | 'confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show'
    - `guestID` string
    - `profileID` string
    - `guestName` string
    - `startDate` string, date
    - `endDate` string, date
    - `allotmentBlockCode` string, nullable — Allotment block code
    - `groupCode` string, nullable — Group profile code
    - `adults` string
    - `children` string
    - `balance` number
    - `sourceName` string — Source of reservation
    - `sourceID` string — Booking source unique id
    - `thirdPartyIdentifier` string
    - `groupInventory` object[], nullable — Aggregate allotment block information
      - `subReservationID` string, nullable — Sub Reservation ID of the specific assigned room
      - `allotmentBlockCode` string, nullable — Allotment block code
      - `startDate` string, date, nullable — Check-In date of the room
      - `endDate` string, date, nullable — Check-Out date of the room
    - `subReservationID` string, nullable — If roomID or roomName are given, the respective subReservationID (to that room) is informed.
    - `customFields` object[], nullable — List of reservation custom fields. Only returned if "includeCustomFields" is true
      - `customFieldID` string, nullable — Unique identifier of the custom field definition (matches /getCustomFields.customFieldID).
      - `shortcode` string, nullable — Stable internal code of the custom field (matches /getCustomFields.shortcode).
      - `isActive` boolean, nullable — Whether the custom field definition is active (true) or archived (false).
      - `customFieldName` string, nullable — Custom Field Name
      - `customFieldValue` string, nullable — Custom Field Value
    - `rooms` object[] — Array with rooms information. Only returned if "includeAllRooms" is true
      - `roomTypeID` string — Room Type ID
      - `roomTypeName` string — Room Type Name
      - `roomTypeIsVirtual` boolean — If room is virtual (true) or physical (false)
      - `subReservationID` string — sub Reservation ID (specific to each room)
      - `isRoomLocked` boolean — Whether the reservation room assignment is locked. Locked reservations cannot be reassigned via the calendar UI.
      - `guestID` string — ID of the main guest assigned to the room
      - `guestName` string — Name of the main guest assigned to the room
      - `adults` string — Number of adults in the room
      - `children` string — Number of children in the room
      - `reservationRoomID` string — Reservation room ID
      - `roomID` string — Room ID (null if the reservation has not been assigned a specific room yet).
      - `roomName` string, nullable — Name of the room, if roomID=null it does not exist.
      - `roomCheckIn` string — Check-in date for the room
      - `roomCheckOut` string — Check-out date for the room
      - `roomStatus` 'cancelled' | 'in_house' | 'checked_out' | 'not_checked_in'
      - `marketName` string — Market segmentation name
      - `marketCode` string — Market segmentation code
    - `guestList` object, nullable — A map of guest IDs to guest objects (key is the Guest ID). It contains an entry for each guest included on the reservation. Only returned if "includeGuestsDetails" is true
    - `origin` string — Reservation origin
    - `mealPlans` string — Reservation meal plans
  - `count` integer — Number of results returned
  - `total` integer — Total number of results

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)