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

# getReservation

`GET /getReservation`

Returns information on a booking specified by the reservationID parameter

## Query parameters

- `propertyID` string
- `reservationID` string, required
- `includeGuestRequirements` boolean

## Response `200`

200 Response

- GetReservationResponse
  - `success` boolean — Returns if the request could be completed
  - `data` object — Details for the reservation queried
    - `propertyID` string — Property ID
    - `guestName` string — Main Guest Name
    - `guestEmail` string — Main Guest Email
    - `isAnonymized` boolean — Flag indicating the main guest data was removed upon request
    - `guestList` object — A map of guest IDs to guest objects (key is the Guest ID). It contains an entry for each guest included on the reservation.
    - `reservationID` string — Reservation identifier
    - `dateCreated` string, date-time
    - `dateModified` string, date-time
    - `estimatedArrivalTime` string, time, nullable — Estimated arrival time, 24-hour format.
    - `source` string — Booking source (e.g. Website, Facebook Widget, Booking.com, etc)
    - `sourceID` string — Booking source unique id
    - `thirdPartyIdentifier` string, nullable — If it was received from a booking channel, it displays its identifier. If not, it will be empty
    - `status` 'confirmed' | 'not_confirmed' | 'canceled' | 'checked_in' | 'checked_out' | 'no_show' — Reservation status<br /> 'not_confirmed' - Reservation is pending confirmation<br /> 'confirmed' - Reservation is confirmed<br /> 'canceled' - Reservation is canceled<br /> 'checked_in' - Guest is in hotel<br /> 'checked_out' - Guest already left hotel<br /> 'no_show' - Guest didn't showed up on check-in date
    - `total` number — Total price of the booking
    - `balance` number — Balance currently owed
    - `balanceDetailed` union — Reservation balance detailed with the information available on PC app, describing the financial items calculated
      - object
        - `suggestedDeposit` string — Suggested deposit value, calculated according to the hotel policies. Does not mean that it was effectively paid
        - `subTotal` number — Sum of the room prices on the reservation
        - `additionalItems` number — Sum of the additional items recorded on the reservation
        - `taxesFees` number — Sum of the taxes and fees calculated on the reservation
        - `grandTotal` number — Sum of sub.Total + additionalItems + taxesFees
        - `paid` number — Amount paid (reservation deposit + any other extra payment)
      - object[]
        - `suggestedDeposit` string — Suggested deposit value, calculated according to the hotel policies. Does not mean that it was effectively paid
        - `subTotal` number — Sum of the room prices on the reservation
        - `additionalItems` number — Sum of the additional items recorded on the reservation
        - `taxesFees` number — Sum of the taxes and fees calculated on the reservation
        - `grandTotal` number — Sum of sub.Total + additionalItems + taxesFees
        - `paid` number — Amount paid (reservation deposit + any other extra payment)
    - `assigned` object[] — Assigned Rooms information
      - `reservationRoomID` string — Reservation room ID
      - `roomTypeName` string — Name of the assigned room type
      - `roomTypeNameShort` string — Short name of the assigned room type
      - `roomTypeIsVirtual` boolean — If room is virtual (true) or physical (false)
      - `dormRoomName` string, nullable — Name of the dorm room. Used for the shared dorm beds that are organized into rooms within the same room type
      - `roomTypeID` string — ID of the assigned room type
      - `subReservationID` string — Sub Reservation ID of the specific assigned room
      - `isRoomLocked` boolean — Whether the reservation room assignment is locked. Locked reservations cannot be reassigned via the calendar UI.
      - `roomName` string — Name of the specific assigned room
      - `roomID` string — ID of the specific assigned room
      - `startDate` string, date — Check-In date of the room
      - `endDate` string, date — Check-Out date of the room
      - `adults` string — Number of adult staying in the room
      - `children` string — Number of children staying in the room
      - `dailyRates` object[] — Array with rates detailed by day
        - `date` string, date
        - `rate` number
      - `roomTotal` string — Room total rate
      - `marketName` string — Market segmentation name
      - `marketCode` string — Market segmentation code
    - `unassigned` object[] — Unassigned Rooms information
      - `reservationRoomID` string — Reservation room ID
      - `roomTypeName` string — Name of the room type to be assigned
      - `roomTypeIsVirtual` boolean — If room is virtual (true) or physical (false)
      - `roomTypeID` string — ID of the room type to be assigned
      - `subReservationID` string — Sub Reservation ID of the specific assigned room
      - `isRoomLocked` boolean — Whether the reservation room assignment is locked. Locked reservations cannot be reassigned via the calendar UI.
      - `startDate` string, date — Check-In date of the room
      - `endDate` string, date — Check-Out date of the room
      - `adults` string — Number of adult staying in the room
      - `children` string — Number of children staying in the room
      - `dailyRates` object[] — Array with rates detailed by day
        - `date` string, date
        - `rate` number
      - `roomTotal` string — Room total rate
    - `cardsOnFile` object[] — Credit Cards stored for the reservation
      - `cardID` string — Credit Card ID, used for card operations
      - `cardNumber` string — Ending digits of the credit card
      - `cardType` 'visa' | 'master' | 'amex' | 'diners' — Abbreviated name of credit card type
    - `customFields` object[] — Custom Fields related to the reservation
      - `customFieldID` string — Unique identifier of the custom field definition (matches /getCustomFields.customFieldID).
      - `shortcode` string — Stable internal code of the custom field (matches /getCustomFields.shortcode).
      - `isActive` boolean — Whether the custom field definition is active (true) or archived (false).
      - `customFieldName` string — Custom Field Name
      - `customFieldValue` string — Custom Field Value
    - `startDate` string, date — First reservation check-in date
    - `endDate` string, date — Last reservation check-out date
    - `allotmentBlockCode` string, nullable — Allotment block code
    - `channelProvidedCreditCard` boolean — Whether a credit card was provided by the channel. Only included for reservations originating from OTAs.
    - `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
    - `origin` string — Reservation origin
    - `mealPlans` string — Reservation Meal Plans
  - `message` string, nullable — To be used in case any error occurs (if success = false). If success = true, it does not exist.

---

[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)