---
title: "Retrieve Reservations"
method: GET
path: "/reservations-v3"
tags: ["Reservations Open Api [Beta]"]
---

# Retrieve Reservations

`GET /reservations-v3`

Retrieve multiple reservations by ID. Use this endpoint to get all the relevant information about your reservation including the financial breakdown and guest details

## Query parameters

- `reservationIds` string[], required
- `includePaymentsTemplate` boolean
- `mergeAccommodationFarePriceComponents` boolean
- `mergeInclusiveTaxes` boolean

## Response `200`

Success

- object[]
  - `_id` object, required
  - `groupId` object
  - `sendQuoteId` object
  - `integrationId` object
  - `preApproveState` boolean
  - `stay` object[], required
    - `numberOfGuests` object — Object. Contains the breakdown of the guests
      - `numberOfChildren` number — Number of children
      - `numberOfInfants` number — Number of infants
      - `numberOfPets` number — Number of pets
      - `numberOfAdults` number, required — Number of adults
    - `_id` object
    - `checkInDateLocalized` string, required
    - `checkOutDateLocalized` string, required
    - `guestsCount` number, required
    - `unitTypeId` object, required
    - `unitId` object
    - `ratePlanId` string
    - `eta` string, date-time, required
    - `etd` string, date-time, required
    - `earlyCheckIn` object
    - `lateCheckOut` object
  - `bookerId` string, required
  - `platform` string, required
  - `quoteId` object, required
  - `accountId` object, required
  - `source` string, required
  - `confirmedAt` string, date-time
  - `reservedAt` string, date-time
  - `reservedUntil` -1 | 0.5 | 0.25 | 0.17 | 12 | 24 | 36 | 48 | 72
  - `canceledAt` string, date-time
  - `isAssigned` boolean
  - `moneyId` string
  - `specialRequests` string
  - `keyCode` string
  - `alteredAt` string, date-time
  - `conversationId` string
  - `conversationExternalId` string
  - `transportation` object
  - `agentBooking` boolean
  - `reasonForVisit` 'business' | 'leisure' | 'family' | 'event' | 'other'
  - `canceledBy` 'OWNER' | 'GUEST' | 'TEAM_MEMBER' | 'HOST'
  - `cancellationReason` string
  - `cancellationNote` string
  - `guestStay` object
    - `doneBy` object
      - `id` string
      - `name` string
      - `type` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `status` 'not_set' | 'checked_in' | 'checked_out' | 'no_show', required
  - `pointOfSale` string
  - `creationInfo` object — Reservation creation info. It is used to track the user who created the reservation, currently used for owner reservations.
    - `owner` object
      - `_id` object, required
      - `fullName` string
      - `email` string
      - `phone` string
      - `locale` string
  - `creationFlow` 'OPEN_API' | 'INTERNAL' | 'RESERVATIONS_UPLOAD' | 'MAILER'
  - `origin` string
  - `originId` string
  - `importedAt` string, date-time
  - `manuallyCreated` boolean
  - `uploadedAt` string, date-time — Date when reservation was uploaded through reservations upload feature
  - `unifiedId` string
  - `channelMetadata` object — Reservation channel meta data.
    - `externalReservationId` string, required
    - `externalListingId` string, required
    - `hotelId` string
    - `stayId` string
    - `hostRole` string
    - `loyaltyProgram` 'genius'
    - `createdAt` string, date-time, required
    - `confirmedAt` string, date-time
    - `updatedAt` string, date-time
    - `canceledAt` string, date-time
    - `canceledBy` string
    - `ratePlan` object
      - `name` string
      - `id` string
      - `childId` string
    - `cancellationTerms` object
      - `penaltyAmount` string
      - `reasons` string[]
    - `cancellationPolicy` string
    - `isGroupReservation` boolean
    - `isFullReservationData` boolean
    - `cancellationFee` number
  - `guestPreferences` object — Reservation guest preferences
    - `smoking` boolean
  - `ratePlans` object[]
    - `ratePlanId` object
    - `name` string
    - `mealPlan` string
    - `isExternalModificationFound` boolean
    - `promotionData` object
      - `_id` object, required
      - `name` string, required
      - `externalPromotionId` string, required
    - `cancellationPolicy` string
    - `cancellationPolicyDescription` string
    - `cancellationFee` number
  - `channelsSyncState` object — Channel Reservation sync state
    - `listing` object
      - `unlockOnListingId` string
      - `syncMode` 'DISABLED' | 'ENABLED', required
  - `isUsingVCC` boolean
  - `createdAt` string, date-time, required
  - `bookingDate` string, date-time
  - `customFields` object[]
    - `_id` string, required
    - `fieldId` string, required
    - `value` object, required
  - `status` 'confirmed' | 'reserved' | 'awaiting_payment' | 'inquiry' | 'canceled' | 'closed' | 'declined' | 'expired', required
  - `notes` object, required
    - `other` string
    - `cleaning` string
    - `guest` string
    - `specialRequests` string
    - `keyCode` string
  - `confirmationCode` string, required

## Other responses

- `400` — Returned if required fields are missing or there is a validation error in the request body
- `500` — Indicates server-side error while processing the request

---

[API](https://skmtc.net/guesty/apis/guesty-open-api.md) · [All operations](https://skmtc.net/guesty/apis/guesty-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/guesty/guesty-open-api/versions/7c62644070f2/schema)