--- title: "List bookings" method: GET path: "/bookings" tags: ["Manage bookings"] --- # List bookings `GET /bookings` ## Overview Search for bookings by guest ID or client reference. Perfect for displaying a guest's booking history or finding bookings by your internal reference codes. ## When to Use - **Guest booking history** - Show all bookings for a specific guest - **Reference lookup** - Find bookings by your internal reference codes - **Booking management** - List bookings for administrative purposes - **Customer support** - Quickly find bookings for support tickets ## What You Get - **Booking list** - All matching bookings with complete details - **Guest information** - Name, email, and contact details - **Stay details** - Check-in/check-out dates and hotel information - **Payment status** - Current payment and booking status - **Booking references** - Booking IDs and confirmation codes ## Search Options - **By guest ID** - Find all bookings for a specific guest - **By client reference** - Find bookings using your internal reference codes - **By customTags** - Narrow results by booking labels using `customTags=KEY:VALUE,KEY2:VALUE2` (AND across keys) - **Optional timeout** - Set request timeout (default 4 seconds) ## Quick Start Provide either `guestId` or `clientReference` (or both). Returns matching bookings with full details. ## Query parameters - `clientReference` string - `guestId` string - `customTags` string - `timeout` number, float ## Response `200` OK - object - `data` object[] - `bookingId` string, required — The unique identifier for the confirmed booking. This is used to reference the booking later via the API or calls for support. - `clientReference` string — A reference ID provided by the client (you) for tracking purposes. - `supplierBookingId` string — The booking ID assigned by the supplier. Not needed, use bookingId instead. - `supplierBookingName` string — The name associated with the booking in the supplier's system. By default, Nuitee. - `supplier` string — The supplier handling this booking. By default, Nuitee. - `supplierId` integer — The unique numerical identifier for the supplier. By default, 2 for Nuitee. - `feed` string — Which feed was used for this booking. Null if the default feed was used. - `status` string, required — The current status of the booking. At this point it will be CONFIRMED, the other options for this field are CANCELED or CANCELLED_WITH_CHARGES. - `hotelConfirmationCode` string — The confirmation code issued by the hotel for the booking. Not available at booking time. Nuitee performs a manual process to to contact the hotel and get the confirmation number. - `checkin` string, date, required — The check-in date for the booking (ISO format). - `checkout` string, date, required — The check-out date for the booking (ISO format). - `hotel` object - `hotelId` string — Identifier for the booked hotel. - `name` string — Name of the hotel. - `rooms` object[] - `roomType` object — An object containing details about the booked room type. - `roomTypeId` string — Unique identifier for the room type. - `name` string — The name of the booked room type. - `boardType` string — A short code representing the meal plan included with the booking. - `boardName` string — The full name of the meal plan included in the booking. - `adults` integer — Number of adults in this room. - `children` integer — Number of children in this room. - `rate` object — An object containing rate information for the booked room. - `rateId` string — The unique identifier for a specific rate within the offer. - `retailRate` object — An object with details about the retail price of the booking. - `total` object — an object containing the total cost of the rate - `amount` integer — The total cost amount due to book this room. This is what the end user will pay. - `currency` string — The currency the total is in. - `cancellationPolicies` object — An object containing the cancellation rules and conditions for the booking. - `cancelPolicyInfos` object[] — An array of objects detailing specific cancellation penalties and deadlines. - `cancelTime` string — The deadline to cancel before incurring a fee (ISO datetime format). - `amount` number — The monetary penalty applied if the booking is canceled after the deadline. Can be 0 which means its fully refundable. - `currency` string — The currency of the cancellation fee. - `type` string — The type of cancellation penalty (e.g., 'amount' for a fixed fee). - `timezone` string — The timezone in which the cancellation policy applies. Always GMT, even if not listed. - `hotelRemarks` object[] — An array of additional remarks from the hotel regarding cancellations. - `refundableTag` string — Indicates whether the booking is refundable, Either 'NRFN' for non-refundable or RFN for refundable. - `maxOccupancy` integer — The maximum number of guests allowed in this room. - `boardType` string — A short code representing the meal plan included with the booking. - `boardName` string — The full name of the meal plan included in the booking. - `remarks` string — Any special remarks related to the booking or room type. - `firstName` string — The first name of the person responsible for the booking. - `lastName` string — The last name of the person responsible for the booking. - `childrenAges` integer[], nullable — Ages of children in this room. - `board` string — The full name of the meal plan included in the booking. - `boardCode` string — A short code representing the meal plan included with the booking. - `cancellationPolicies` object — An object containing the cancellation rules and conditions for the booking. - `cancelPolicyInfos` object[] — An array of objects detailing specific cancellation penalties and deadlines. - `cancelTime` string — The deadline to cancel before incurring a fee (ISO datetime format). - `amount` number — The monetary penalty applied if the booking is canceled after the deadline. Can be 0 which means its fully refundable. - `currency` string — The currency of the cancellation fee. - `type` string — The type of cancellation penalty (e.g., 'amount' for a fixed fee). - `timezone` string — The timezone in which the cancellation policy applies. Always GMT, even if not listed. - `hotelRemarks` object[] — An array of additional remarks from the hotel regarding cancellations. - `refundableTag` string — Indicates whether the booking is refundable, Either 'NRFN' for non-refundable or RFN for refundable. - `room_id` string — Unique identifier for the room. - `occupancy_number` integer — Occupancy number within this booking. - `amount` number — Room price for this booking. - `currency` string — Currency code for the room cost. - `children_count` integer — Number of children in this room. - `remarks` string — Additional remarks for this room. - `guests` object[] — Guest details for this room. - `firstName` string — Guest's first name. - `lastName` string — Guest's last name. - `email` string — Guest's email address. - `phone` string — Guest's phone number. - `remarks` string — Remarks specific to this guest. - `occupancyNumber` integer — Occupancy number for this guest. - `holder` object — An object containing details of the person responsible for the booking. - `firstName` string — The first name of the person responsible for the booking. - `lastName` string — The last name of the person responsible for the booking. - `email` string — The email address of the person responsible for the booking. - `phone` string — The phone number of the person responsible for the booking. - `createdAt` string, date-time — Timestamp when the booking was created. - `updatedAt` string, date-time — Timestamp when the booking was last updated. - `cancellationPolicies` object — An object containing the cancellation rules and conditions for the booking. - `cancelPolicyInfos` object[] — An array of objects detailing specific cancellation penalties and deadlines. - `cancelTime` string — The deadline to cancel before incurring a fee (ISO datetime format). - `amount` number — The monetary penalty applied if the booking is canceled after the deadline. Can be 0 which means its fully refundable. - `currency` string — The currency of the cancellation fee. - `type` string — The type of cancellation penalty (e.g., 'amount' for a fixed fee). - `timezone` string — The timezone in which the cancellation policy applies. Always GMT, even if not listed. - `hotelRemarks` object[] — An array of additional remarks from the hotel regarding cancellations. - `refundableTag` string — Indicates whether the booking is refundable, Either 'NRFN' for non-refundable or RFN for refundable. - `specialRemarks` string — Special requests or remarks for the booking. - `price` number — The final total price of all rooms on the booking. - `commission` number — The total commission amount associated with all rooms on the booking. - `clientCommission` number — Commission amount for the client. - `currency` string, required — The currency in which the booking price is displayed. - `guestId` string — Guest ID associated with the booking. - `trackingId` string — Tracking identifier for the booking. - `prebookId` string — Identifier from the pre-booking step. - `paymentStatus` string — Status of the payment for the booking. - `paymentTransactionId` string — Transaction identifier for the payment. - `sellingPrice` string — Total selling price of the booking. - `exchangeRate` number — Exchange rate used for currency conversion. - `exchangeRateUsd` number — USD exchange rate for the booking. - `email` string — Email of the guest or booking holder. - `tag` string — Indicates if the booking is refundable ('RFN' for refundable, 'NRFN' for non-refundable). - `lastFreeCancellationDate` string, date-time — The latest date/time when the booking can be canceled without penalties (ISO 8601 format). - `userId` integer — ID of the user who made the booking. - `nationality` string — Nationality of the guest. - `loyaltyGuestId` integer — Loyalty or membership ID of the guest. - `cancelledAt` string, date-time — Timestamp when the booking was cancelled. - `refundedAt` string, date-time — Timestamp when the booking was refunded. - `cancelledBy` integer — User ID or agent ID who cancelled the booking. - `sandbox` integer — Indicates if this booking is in sandbox mode (0 or 1). - `voucherId` string — ID of any voucher used. - `voucherTotalAmount` number — Total amount covered by a voucher. - `voucherTransationId` string — Transaction ID associated with the voucher. - `processingFee` number — Processing fee for the booking. - `amountRefunded` number — Total amount refunded for this booking. - `refundType` string — Type of refund (e.g., full, partial). - `paymentScheduledAt` string — Scheduled time for the payment process. - `addonsTotalAmount` number — The total amount charged for any additional services or extras. - `addonsRedemptions` string — Details of any add-on redemptions. - `rebookFrom` string — Original booking ID if this booking was rebooked. - `agentId` integer — ID of the agent who made the booking, if applicable. - `suggestedSellingPrice` object — The minimum public selling price for all the rooms combined. This is used for pricing control. - `amount` number — The minimum amount the room can be sold for publicly. - `currency` string — The currency the suggestedSellingPrice is in. - `source` string — The source of the suggestedSellingPrice if we have it. ex: 'expedia.com' or 'providerDirect'. - `goodwillPayment` object — Goodwill payment information for the booking. - `amount` number — The amount of the payment. - `currency` string — The currency of the payment. - `description` string — Short description of the payment. - `customTags` object — User-defined key/value labels persisted at booking time. Keys match `^[A-Z0-9_-]+$`, values are strings up to 255 characters, capped at 5 entries. ## Other responses - `401` — Unauthorized --- [API](https://skmtc.net/liteapi/apis/api-search.md) · [All operations](https://skmtc.net/liteapi/apis/api-search/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/liteapi/api-search/versions/315ba2a4dcf4/schema)