--- title: "List of bookings" method: GET path: "/v2/reservations/bookings" tags: ["Reservations"] --- # List of bookings `GET /v2/reservations/bookings` ## Request - Base URL: `https://api.lodgify.com` - URL: `https://api.lodgify.com/v2/reservations/bookings` - Auth: API key in header `X-ApiKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieve a list of bookings matching the query parameters ## Query parameters - `page` integer - `size` integer - `includeCount` boolean - `stayFilter` 'Upcoming' | 'Current' | 'Historic' | 'All' | 'ArrivalDate' | 'DepartureDate' - `updatedSince` string, date-time - `includeTransactions` boolean - `includeExternal` boolean - `includeQuoteDetails` boolean - `trash` 'False' | 'True' | 'All' - `stayFilterDate` string, date-time ## Response `200` OK - LodgifyApiPublicReservationsModelsV2ReservationsBookingsBookingSetDto - `count` integer, nullable - `items` LodgifyApiPublicReservationsModelsV2ReservationsBookingsBookingDto[], nullable - `id` integer: Id of the booking - `user_id` integer: User the booking belongs to - `arrival` string: Arrival date - `departure` string: Departure date - `property_id` integer: Id of the property - `rooms` LodgifyApiPublicReservationsModelsV2ReservationsBookingsBookingRoomDto[], nullable: Rooms booked - `room_type_id` integer: Id of the room type booked - `guest_breakdown` LodgifyApiPublicReservationsModelsV12GuestBreakdownDto, required: The breakdown of guests for the booking or enquiry - `adults` integer: The number of adults - `children` integer: The number of children - `infants` integer: The number of infants - `pets` integer: The number of pets - `people` integer: Deprecated. Map to GuestBreakdown.Adults - `key_code` string, nullable: KeyCode to access the property or room rented - `guest` LodgifyApiPublicReservationsModelsV2ReservationsBookingsGuestDto: Guest information related to the Booking - `name` string, nullable: Name of the guest - `email` string, nullable: Email of the guest - `phone` string, nullable: Phone number of the guest - `country_code` string, nullable: Code of the country the Guest is from - `language` string, nullable: Language selected by the guest - `status` 'Open' | 'Tentative' | 'Booked' | 'Declined': Status information of the Booking - `is_unavailable` boolean: Booking cannot be booked because calendar is not available - `is_overbooked` boolean: Booking is overbooked - `tentative_expires_at` string, date-time, nullable: Time the Tentative status will expire at - `source` 'Manual' | 'OH' | 'NineFlats' | 'Airbnb' | 'AirbnbIntegration' | 'HomeAway' | 'BookingCom' | 'Expedia' | 'ICal' | 'Email' | 'FacebookMessenger' | 'PublicApi' | 'Other': Type of source the Booking comes from - `source_text` string, nullable: Details of the booking from the source - `created_from_ip` string, nullable: Ip the booking was created from - `created_at` string, date-time: Time the booking was created at - `updated_at` string, date-time: Last time the booking was updated - `canceled_at` string, date-time, nullable: Date the booking was canceled at - `is_new` boolean: When it is new, the owner has not seen the booking yet - `is_deleted` boolean: When it is deleted, the owner moved the booking to trash - `currency_code` string, nullable: Currency in which all amounts are expressed for this booking - `total_amount` LodgifyAppTypesMoney1 - `subtotals` LodgifyApiPublicReservationsModelsV2ReservationsBookingsSubtotalDto: Subtotal information of the Booking - `stay` LodgifyAppTypesMoney1 - `promotions` LodgifyAppTypesMoney1 - `fees` LodgifyAppTypesMoney1 - `taxes` LodgifyAppTypesMoney1 - `addons` LodgifyAppTypesMoney1 - `vat` LodgifyAppTypesMoney1 - `amount_paid` LodgifyAppTypesMoney1 - `amount_due` LodgifyAppTypesMoney1 - `quote` LodgifyApiPublicReservationsModelsV2ReservationsQuotesQuoteDto: Quote information related to the Booking - `id` integer: Id of the Quote - `policy` LodgifyApiPublicReservationsModelsV2ReservationsQuotesPolicyDto: Policy information related to the Booking - `name` string, nullable: Name of the policy - `payments` string, nullable: Description of the payment policy - `cancellation` string, nullable: Description of the cancellation policy - `damage_deposit` string, nullable: Description of the damage deposit policy - `status` 'Null' | 'NotScheduled' | 'NotSent' | 'Agreed' | 'CancelledByOwner' | 'CancelledByGuest' | 'Rejected' | 'Deactivated' | 'ExpiredByGuest' | 'ExpiredByOwner' | 'PendingForOwner' | 'PendingForGuest' | 'PendingForPayment' | 'RedirectedToOffsitePayment' | 'ChangeRequested' | 'Changed' | 'Disconnected': Information about the quote status - `scheduled_transactions` LodgifyApiPublicReservationsModelsV2ReservationsQuotesScheduledTransactionDto[], nullable: Schedule details enforced by the Quote - `id` integer: Id of the scheduled item - `type` 'PrePayment' | 'InterimPayment' | 'BalancePayment' | 'PrecedingPayment' | 'Cancellation' | 'DamageDepositAuthorization' | 'DamageDepositVoid' | 'SecurityDepositCharge' | 'SecurityDepositRefund': Type of scheduled transaction - `status` 'Scheduled' | 'Overdue' | 'Pending' | 'Partial' | 'Aborted' | 'Paid' | 'Refunded' | 'Authorized' | 'Voided' | 'Captured' | 'Shown': Status of a scheduled transaction - `amount` LodgifyAppTypesMoney1 - `due_at` string, nullable: The date the schedule item will be due at. Null means that the date will be the date of the booking agreement. - `scheduled_damage_protection` LodgifyApiPublicReservationsModelsV2ReservationsQuotesScheduledTransactionDto[], nullable: Schedule details of damage protection enforced by the Quote - `id` integer: Id of the scheduled item - `type` 'PrePayment' | 'InterimPayment' | 'BalancePayment' | 'PrecedingPayment' | 'Cancellation' | 'DamageDepositAuthorization' | 'DamageDepositVoid' | 'SecurityDepositCharge' | 'SecurityDepositRefund': Type of scheduled transaction - `status` 'Scheduled' | 'Overdue' | 'Pending' | 'Partial' | 'Aborted' | 'Paid' | 'Refunded' | 'Authorized' | 'Voided' | 'Captured' | 'Shown': Status of a scheduled transaction - `amount` LodgifyAppTypesMoney1 - `due_at` string, nullable: The date the schedule item will be due at. Null means that the date will be the date of the booking agreement. - `room_type_items` LodgifyApiPublicReservationsModelsV2ReservationsQuotesBookingQuoteRoomTypeItemDto[], nullable: Room types belonging to the Quote - `room_type_id` integer: Room type identifier - `subtotal` LodgifyAppTypesMoney1 - `prices` LodgifyApiPublicReservationsModelsV2ReservationsQuotesBookingQuotePriceItemDto[], nullable: Items belonging to the Quote related to this Room type - `type` string, nullable: Quote item type - `amount` LodgifyAppTypesMoney1 - `description` string, nullable: Quote item description - `addon_items` LodgifyApiPublicReservationsModelsV2ReservationsQuotesBookingQuotePriceItemDto[], nullable: Addons belonging to the Quote - `type` string, nullable: Quote item type - `amount` LodgifyAppTypesMoney1 - `description` string, nullable: Quote item description - `other_items` LodgifyApiPublicReservationsModelsV2ReservationsQuotesBookingQuotePriceItemDto[], nullable: Other items belonging to the Quote - `type` string, nullable: Quote item type - `amount` LodgifyAppTypesMoney1 - `description` string, nullable: Quote item description - `vat_items` LodgifyApiPublicReservationsModelsV2ReservationsQuotesBookingQuotePriceItemDto[], nullable: Vat items belonging to the Quote - `type` string, nullable: Quote item type - `amount` LodgifyAppTypesMoney1 - `description` string, nullable: Quote item description - `rental_contract_uid` LodgifyApiPublicReservationsModelsV2ReservationsQuotesRentalContractUidDto: Rental contract unique identifier - `hash` string, uuid: Rental contract hash code - `uid` string, uuid: Rental contract unique identifier - `transactions` LodgifyApiPublicReservationsModelsV2ReservationsBookingTransactionsTransactionDto[], nullable: Transaction details of the booking - `id` integer: Id of the transaction - `type` 'Payment' | 'Refund' | 'Show' | 'Authorization' | 'Void' | 'Capture': Type of transaction - `status` 'Requested' | 'Processing' | 'Done' | 'Failed' | 'Canceled' | 'Abandoned' | 'Unknown': Information about the status of the Transaction - `payment_type` 'None' | 'PaypalWallet' | 'BankAccount' | 'StripeSpreedly' | 'Payyo' | 'AuthorizeNetSpreedly' | 'BraintreeSpreedly' | 'PayPalProSpreedly' | 'PciProxy' | 'SpreedlyTestSpreedly' | 'StripeSca' | 'LodgifyPaymentsStripe': Information about the payment type of the Transaction - `description` string, nullable: Description of the transaction - `amount` LodgifyAppTypesMoney1 - `processed_at` string, date-time, nullable: The time the transaction was processed at - `damage_protection` LodgifyApiPublicReservationsModelsV2ReservationsBookingTransactionsTransactionDto[], nullable: Damage-protection transaction details of the booking - `id` integer: Id of the transaction - `type` 'Payment' | 'Refund' | 'Show' | 'Authorization' | 'Void' | 'Capture': Type of transaction - `status` 'Requested' | 'Processing' | 'Done' | 'Failed' | 'Canceled' | 'Abandoned' | 'Unknown': Information about the status of the Transaction - `payment_type` 'None' | 'PaypalWallet' | 'BankAccount' | 'StripeSpreedly' | 'Payyo' | 'AuthorizeNetSpreedly' | 'BraintreeSpreedly' | 'PayPalProSpreedly' | 'PciProxy' | 'SpreedlyTestSpreedly' | 'StripeSca' | 'LodgifyPaymentsStripe': Information about the payment type of the Transaction - `description` string, nullable: Description of the transaction - `amount` LodgifyAppTypesMoney1 - `processed_at` string, date-time, nullable: The time the transaction was processed at - `notes` string, nullable: Notes added by the owner - `thread_uid` string, uuid: Uid of the message thread the booking belongs to - `external_booking` string, nullable: Booking information as received from an external channel - `check_in` LodgifyApiPublicReservationsModelsV2ReservationsBookingsCheckInViewModel: Represents check-in for a booking - `time` string, nullable: The check-in time Format: HH:mm:ss - `initiator` string, nullable: The check-in source of change - `check_out` LodgifyApiPublicReservationsModelsV2ReservationsBookingsCheckOutViewModel: Represents check-out for a booking - `time` string, nullable: The check-out time Format: HH:mm:ss - `initiator` string, nullable: The check-out source of change - `upgraded_enquiry_id` integer, nullable: If the booking was upgraded from an enquiry, this is the Id of the original enquiry. ## Other responses - `400`: Bad Request - `401`: Unauthorized - `404`: Not Found - `500`: Internal Server Error --- [API](https://skmtc.dev/lodgify/apis/lodgify-public-api-v1.md) - [All operations](https://skmtc.dev/lodgify/apis/lodgify-public-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/lodgify/apis/lodgify-public-api-v1/revisions/ddf40757d411?raw)