# Guesty Booking Engine API Documentation > The Booking Engine API is a set of API endpoints that allow PMs to connect their own websites, including the Booking Engine functionality - directly to Guesty. Append .md to any documentation page URL to get its markdown version. ## Guides - [Quick start guide](https://booking-api-docs.guesty.com/docs/quick-start.md): Guesty's Booking Engine API enables developers to integrate real-time availability, pricing, and booking functionality into external websites and applications. This guide helps you understand the basics and get up and running quickly. - [Authentication](https://booking-api-docs.guesty.com/docs/authentication-1.md): How to authenticate Booking Engine API requests. - [Booking Flow Migration](https://booking-api-docs.guesty.com/docs/booking-flow-migration.md): How to move from the old booking flow resources to the newer ones. - [Booking Website Flow](https://booking-api-docs.guesty.com/docs/booking-flow.md) - [Reservation Quote Flow](https://booking-api-docs.guesty.com/docs/new-reservation-creation-flow.md): Understand the reservation quote flow. - [GuestyPay Tokenization Flow](https://booking-api-docs.guesty.com/docs/tokenizing-payment-methods.md): How to safely tokenize credit card details for the GuestyPay payment method. - [Stripe Tokenization Flow](https://booking-api-docs.guesty.com/docs/stripe-tokenization-flow.md): Tokenize the credit card in Stripe to use it for guest payment. - [Retrieve Accurate Stay Pricing (pilot)](https://booking-api-docs.guesty.com/docs/retrieve-accurate-stay-pricing.md): How to retrieve the total price of a booking to provide guests with accurate final prices. - [Understanding the Upsell Workflow](https://booking-api-docs.guesty.com/docs/understanding-the-upsell-workflow.md): How to retrieve available upsells for a quote, apply selected upsells, and troubleshoot missing upsell fees. - [Google Vacation Rentals (VR)](https://booking-api-docs.guesty.com/docs/google.md): Integrate Google VR with your Booking Engine API. - [Frequently Asked Questions](https://booking-api-docs.guesty.com/docs/frequently-asked-questions.md): FAQs to assist in troubleshooting common errors. ## API Reference - [Quick Start Guide](https://booking-api-docs.guesty.com/reference/quick-start-guide.md): Guesty's Booking Engine API enables developers to integrate real-time availability, pricing, and booking functionality into external websites and applications. This guide helps you understand the basics and get up and running quickly. - [Handling Failed Requests](https://booking-api-docs.guesty.com/reference/handling-failed-requests.md): Managing failed requests using a retry mechanism with exponential backoff, jitter, and a maximum cap. - [Get all the listings included in the booking engine](https://booking-api-docs.guesty.com/reference/getapplicationlistingslist.md): This call returns the list of listings connected to the requester Booking Engine API instance in Guesty and filtered by given parameters. - [Get a specific listing](https://booking-api-docs.guesty.com/reference/getapplicationlisting.md): This call returns a listing by ID - [Get list of cities](https://booking-api-docs.guesty.com/reference/getcities.md): Returns a list of all the cities countries and states related to the booking engine listings - [Get listing availability calendar](https://booking-api-docs.guesty.com/reference/getcalendarbylistingid.md): Return a listing calendar for period - [Get listing's payment provider](https://booking-api-docs.guesty.com/reference/getpaymentproviderbylistingid.md): Return a payment provider - [Create a reservation quote](https://booking-api-docs.guesty.com/reference/createreservationquote.md): Create a reservation quote to hold booking offer for certain period of time. A "default"/"standard" rate plan is supplied for properties that aren't assigned to an active [Revenue Management Rate Plan](https://help.guesty.com/hc/en-gb/articles/9365605981469-Managing-rate-plans). Ensure you only use the rate plans supplied with the quote to create your reservation. > ❗ Important > > Before using the Booking Engine (BE) API reservation endpoints, ensure your Guesty account is properly activated by following these steps: > 1. Activate Manual Source (skip this step if you already have direct reservations in Guesty account): > - Create a manual reservation directly in the Guesty UI. This step is required to activate the "Manual" booking source in your account. > 2. Activate BE API Source: > - Create your first reservation using the Booking Engine API endpoints. > - This step is essential to initialize the BE API source, which allows you to set up additional fees, taxes, auto payments and automated messages. - [Retrieve a quote](https://booking-api-docs.guesty.com/reference/retrievequotebyid.md): Retrieve a quote by ID. - [Update coupon in a quote](https://booking-api-docs.guesty.com/reference/managerateplanquotecoupons.md): Ability to add/remove a coupon from existing quote. - [Create instant reservation based on quote](https://booking-api-docs.guesty.com/reference/createinstantreservationfromquote.md): Create instant reservation based on quote to use the same data which the quote holds. Pre-SCA Stripe tokens (starting with `tok_...`) are NOT SUPPORTED. The API supports only Stripe SCA tokens (starting with `pm_...`). > ❗ Important > > Before using the Booking Engine (BE) API reservation endpoints, ensure your Guesty account is properly activated by following these steps: > 1. Activate Manual Source (skip this step if you already have direct reservations in Guesty account): > - Create a manual reservation directly in the Guesty UI. This step is required to activate the "Manual" booking source in your account. > 2. Activate BE API Source: > - Create your first reservation using the Booking Engine API endpoints. > - This step is essential to initialize the BE API source, which allows you to set up additional fees, taxes, auto payments and automated messages. - [Create inquiry for reservation based on quote](https://booking-api-docs.guesty.com/reference/createinquiryreservationfromquote.md): Create a request for a reservation to be confirmed by the Guesty user based on a quote. Pre-SCA Stripe tokens (starting with `tok_...`) are NOT SUPPORTED. The API supports only Stripe SCA tokens (starting with `pm_...`). > ❗ Important > > Before using the Booking Engine (BE) API reservation endpoints, ensure your Guesty account is properly activated by following these steps: > 1. Activate Manual Source (skip this step if you already have direct reservations in Guesty account): > - Create a manual reservation directly in the Guesty UI. This step is required to activate the "Manual" booking source in your account. > 2. Activate BE API Source: > - Create your first reservation using the Booking Engine API endpoints. > - This step is essential to initialize the BE API source, which allows you to set up additional fees, taxes, auto payments and automated messages. - [Create an instant reservation if a credit card charge is successful](https://booking-api-docs.guesty.com/reference/createinstantchargereservationfromquote.md): Create an instant reservation based on a quote, with an immediate charge using a Stripe confirmation token or the initialPaymentMethodId when GuestyPay is used. This endpoint allows you to charge a reservation before confirming the reservation. If the charge fails, the reservation is not created. Stripe's confirmation token is generated using Stripe frontend embedded component. See [Stripe docs](https://docs.stripe.com/payments/build-a-two-step-confirmation#create-ct) for more information. > > The initialPaymentMethodId is created using our dedicated SDK v2. Documentation can be found [here](https://github.com/guestyorg/tokenization-js/wiki/v2-Integration). > Before requesting this endpoint, when GuestyPay is used, the SDK submit function must be called to get the initialPaymentMethodId. The payload option 1 should be used and the email must also be sent in the guest data. After this request, if the status of the payment is PENDING_AUTH, the `/verify-payment` endpoint must be called. > > ❗ Important > > Before using the Booking Engine (BE) API reservation endpoints, ensure your Guesty account is properly activated by following these steps: > 1. Activate Manual Source (skip this step if you already have direct reservations in Guesty account): > - Create a manual reservation directly in the Guesty UI. This step is required to activate the "Manual" booking source in your account. > 2. Activate BE API Source: > - Create your first reservation using the Booking Engine API endpoints. > - This step is essential to initialize the BE API source, which allows you to set up additional fees, taxes, auto payments and automated messages. - [Retrieve a reservation by ID](https://booking-api-docs.guesty.com/reference/getquotereservationbyid.md): Retrieve a reservation created with quote by ID - [Verify the payment for a reservation created with instant charge](https://booking-api-docs.guesty.com/reference/verifychargeforreservationfromquote.md): Verify the payment for a reservation created with instant charge when Guesty Pay is used. It should be called immediately after the `/instant-charge` endpoint when the returned payment has status `PENDING_AUTH`. If the 3DS verification succeeds, the payment is charged and the reservation is confirmed. If the verification fails, the reservation is closed. > For providers with GuestyPay protect, the threeDSResult object is returned from the SDK handle3DSChallenge fuction and it should be sent here for 3DS challenge verification. If GuestyPay in EU/UK, this object is not necessary. - [Retrieve a payouts schedule for a listing](https://booking-api-docs.guesty.com/reference/retrievepayoutsschedule.md): This endpoint is used to retrieve a payouts schedule for a listing. It returns a list of payouts, including the payout amount, date, and status. - [Retrieve reviews](https://booking-api-docs.guesty.com/reference/getreviewslist.md): Get reviews list by parameters - [Retrieve upsell [Pilot]](https://booking-api-docs.guesty.com/reference/retrieveupsellfee.md): This call returns the list of upsell fee available to the requester listing in quote [Pilot] - [Update upsell in a quote [Pilot]](https://booking-api-docs.guesty.com/reference/replaceupsellfees.md): Ability to add/remove a upsell from existing quote. [Pilot] - [Upsert metasearch config](https://booking-api-docs.guesty.com/reference/upsertmetasearchconfig.md): Upsert metasearch config - [Get metasearch config](https://booking-api-docs.guesty.com/reference/getmetasearchconfig.md): Get metasearch config ## Recipes - [Access token management](https://booking-api-docs.guesty.com/recipes/access-token-management.md) - [API traffic management](https://booking-api-docs.guesty.com/recipes/api-traffic-management.md) ## Changelog - [2026-05-18](https://booking-api-docs.guesty.com/changelog/2026-05-18.md) - [Included Taxes - 2026-02-15](https://booking-api-docs.guesty.com/changelog/include-taxes-2026-02-15.md) - [Fixed Upsells path parameters - 2026-02-09](https://booking-api-docs.guesty.com/changelog/documentation-update-corrected-path-parameter-names-for-upsell-endpoints.md) - [GuestyPay Support and SDK](https://booking-api-docs.guesty.com/changelog/guestypay-support-and-sdk.md) - [API Rate Limits Correction](https://booking-api-docs.guesty.com/changelog/api-rate-limits-correction.md) - [New Guide: Google VR Integration](https://booking-api-docs.guesty.com/changelog/new-guide-google-vr-integration.md) - [New Guides](https://booking-api-docs.guesty.com/changelog/new-guides.md) - [Payment Method for Stripe Updated](https://booking-api-docs.guesty.com/changelog/payment-method-for-stripe-updated.md) - [New endpoint for retrieving reservations](https://booking-api-docs.guesty.com/changelog/new-endpoint-for-retrieving-reservations.md) - [New Stripe Payments Guidance](https://booking-api-docs.guesty.com/changelog/new-stripe-payments-guidance.md)