# Guesty Open API Documentation
## Guides
- [Vendors](https://open-api-docs.guesty.com/docs/vendors.md): How to retrieve vendor information.
- [Guesty MCP Server (beta)](https://open-api-docs.guesty.com/docs/guesty-mcp-server-beta.md): Guesty MCP Server enables MCP-compatible AI assistants to connect to Guesty API
- [Building a Direct Booking Website Using Guesty API](https://open-api-docs.guesty.com/docs/moving-your-website-from-guestys-legacy-api-to-booking-engine-api.md): The best API for a booking website.
- [Syncing Reservation Financials with an External Invoicing or Financial Reporting Solution](https://open-api-docs.guesty.com/docs/syncing-reservation-financials-with-an-external-invoicing-or-financial-reporting-solution.md): How to extract the guest invoice and payment information from a reservation.
- [Troubleshooting API Error Codes](https://open-api-docs.guesty.com/docs/troubleshooting-api-error-codes.md): 10 error status codes when building APIs for the first time and how to fix them.
- [Calendar Block Types](https://open-api-docs.guesty.com/docs/calendar-block-types.md): How to read and understand calendar blocks.
- [Calendar Webhooks](https://open-api-docs.guesty.com/docs/webhooks-calendar.md): Webhook notifications for calendar activity.
- [Canceling or Editing a Scheduled Payment](https://open-api-docs.guesty.com/docs/canceling-or-editing-a-scheduled-payment.md): How to alter a future payment.
- [Fetch Reservation Payment Schedules](https://open-api-docs.guesty.com/docs/fetch-reservation-payment-schedules.md): How to retrieve payment schedules per quote or reservations.
- [Payment Transactions API Reference](https://open-api-docs.guesty.com/docs/payment-transactions-api-reference.md): How to retrieve transaction data from your GuestyPay payment processor.
- [Payouts Reconciliation API Reference](https://open-api-docs.guesty.com/docs/payouts-reconciliation-api-reference.md): How to retrieve GuestyPay transactions for reconciliation purposes.
- [Posting a Guest Payment](https://open-api-docs.guesty.com/docs/posting-a-guest-payment.md): How to collect payment from a Guest and how to return a refund to the guest.
- [Recording an External Guest Payment/Refund](https://open-api-docs.guesty.com/docs/recording-external-guest-payments.md): Use this guide to understand how to record external payments/refunds on a reservation.
- [Refunding a Guest Payment](https://open-api-docs.guesty.com/docs/refunding-a-guest-payment.md): How to refund a guest payment.
- [Retrieve the Payment Provider ID](https://open-api-docs.guesty.com/docs/retrieving-the-payment-provider-id.md): How to retrieve a listing's payment provider ID.
- [Stripe Tokenization Flow](https://open-api-docs.guesty.com/docs/stripe-tokenization-flow-copy.md): Tokenize the credit card in Stripe to use it for guest payment.
- [GuestyPay Tokenization Flow](https://open-api-docs.guesty.com/docs/tokenizing-payment-methods.md): How to safely tokenize credit card details for the GuestyPay payment method.
- [Payment Webhooks](https://open-api-docs.guesty.com/docs/webhooks-payments.md): Webhook notifications for reservation payment events.
- [Fields/Columns for Guest Reports](https://open-api-docs.guesty.com/docs/fields-for-guest-reports.md): Describes the guest columns or fields that can be returned in reports.
- [Guest Webhooks](https://open-api-docs.guesty.com/docs/webhooks-guests.md): Webhook notifications for the creation, alteration and deletion of guest objects.
- [Retrieve Message Attachments](https://open-api-docs.guesty.com/docs/retrieve-message-attachments.md): How to identify and retrieve message attachments.
- [Message Webhooks](https://open-api-docs.guesty.com/docs/webhooks-messages.md): Webhook notifications for new messages in the Guest Inbox.
- [Optimized Calendar Webhook and Endpoint](https://open-api-docs.guesty.com/docs/calendar-webhook-migration.md): Introducing a new lightweight calendar webhook.
- [Custom Reservation Fields Migration](https://open-api-docs.guesty.com/docs/custom-reservation-fields-migration.md): How to move from the old custom reservation fields endpoints to the new ones.
- [Authentication](https://open-api-docs.guesty.com/docs/authentication.md): Generating an access token to authenticate Open API requests.
- [Quick start guide](https://open-api-docs.guesty.com/docs/quick-start-guide.md): Guesty's Open API allows property managers and developers to programmatically interact with the Guesty platform. This guide walks you through the initial setup, authentication, and how to make your first API call.
- [Postman Guide](https://open-api-docs.guesty.com/docs/postman-guide.md): Use Postman to explore Guesty's OpenAPI. You will need an active Guesty account to send requests and receive responses.
- [Rate Limits](https://open-api-docs.guesty.com/docs/rate-limits.md): Guesty's Open API rate limits and how to work with them.
- [Upgrading Third-Party Access to Your Guesty Account](https://open-api-docs.guesty.com/docs/upgrading-third-party-access-to-your-guesty-account.md): How to integrate external applications with your Guesty account.
- [Webhooks Overview](https://open-api-docs.guesty.com/docs/webhooks.md): A summary of the webhook notifications provided by Guesty.
- [Rooms, Beds, and Bathrooms](https://open-api-docs.guesty.com/docs/bedrooms-beds.md): Configure the rooms, beds, and bathrooms at your property.
- [Booking Settings](https://open-api-docs.guesty.com/docs/booking-settings.md): Define a property's booking window and default availability.
- [Create a Property](https://open-api-docs.guesty.com/docs/create-a-property.md): How to create a listing in Guesty.
- [Deactivate and Activate a Property](https://open-api-docs.guesty.com/docs/deactivating-listings.md): How to deactivate and activate a property in Guesty.
- [List and Unlist Properties](https://open-api-docs.guesty.com/docs/list-and-unlist-properties.md): How to list on and hide properties from the booking channel marketplaces.
- [Property Descriptions](https://open-api-docs.guesty.com/docs/listing-descriptions.md): How to edit a property's marketing descriptions.
- [Property Financials](https://open-api-docs.guesty.com/docs/listing-financials.md): An explanation of a property's default financials.
- [Property Location Details](https://open-api-docs.guesty.com/docs/listing-location.md): Retrieve an existing listing's address or update a listing's address and related details.
- [Property Photos](https://open-api-docs.guesty.com/docs/listing-photos.md): The advantages of listing photos and how to use the API to manage them.
- [Searching for Available Listings and All Listings](https://open-api-docs.guesty.com/docs/searching-for-available-listings-and-all-listings.md): How to use the listings endpoint to return a curated collection of listing objects.
- [Listing Webhooks](https://open-api-docs.guesty.com/docs/webhooks-listings.md): Webhook notifications for changes to listings.
- [Predefined Additional Fees](https://open-api-docs.guesty.com/docs/predefined-additional-fee-types.md): List of additional fees that can be configured on Guesty and added to reservations.
- [Supported Amenities](https://open-api-docs.guesty.com/docs/supported-amenities.md): This document provides a comprehensive reference for all supported amenities, organized by category, with their corresponding channel mappings and fee codes.
- [Valid Enumerations](https://open-api-docs.guesty.com/docs/valid-enumerations.md): Tables of valid values for enumerations.
- [Query Available Listings](https://open-api-docs.guesty.com/docs/available-listings.md): Retrieving available listings via the OAPI
- [Create a Reservation](https://open-api-docs.guesty.com/docs/create-a-reservation.md): How to create a reservation using the OAPI
- [Create a Guest and Payment Method](https://open-api-docs.guesty.com/docs/create-guest-and-payment-method.md): Learn how to create a guest and link a payment method for processing reservation payments.
- [Booking Flow](https://open-api-docs.guesty.com/docs/booking-flow.md): Guide to booking workflows with the Open API.
- [How to Search for Reservations](https://open-api-docs.guesty.com/docs/how-to-search-for-reservations.md): Learn how to filter your reservations search to return a curated response.
- [Publish a Custom Review](https://open-api-docs.guesty.com/docs/publish-a-custom-review.md): How to upload external reviews to Guesty
- [Canceling a Booking or Inquiry](https://open-api-docs.guesty.com/docs/canceling-a-booking-or-inquiry.md): Understand the different reservation cancellation flows.
- [Extend or Shorten a Reservation](https://open-api-docs.guesty.com/docs/extend-or-shorten-a-reservation.md): How to extend or shorten a guest's confirmed reservation.
- [Reservation Alterations](https://open-api-docs.guesty.com/docs/reservation-alterations.md): Common alterations performed on current and future reservations.
- [Relocating a Guest](https://open-api-docs.guesty.com/docs/relocating-a-guest.md): Moving a reservation to another listing.
- [Reservations V3 Booking Flow](https://open-api-docs.guesty.com/docs/reservations-v3-booking-flow.md): A guide to creating quotes and direct bookings with the Open API
- [Reservation Webhooks](https://open-api-docs.guesty.com/docs/webhooks-reservations.md): Webhook notifications for reservation activity.
- [Tasks Webhooks](https://open-api-docs.guesty.com/docs/webhooks-tasks.md): Webhook notifications for task-related actions.
## API Reference
- [Authentication](https://open-api-docs.guesty.com/reference/authentication-2.md): How to authenticate your API requests.
- [Get Started](https://open-api-docs.guesty.com/reference/get-started.md): This guide walks you through the initial setup, authentication, and how to make your first API call.
- [Handling Failed Requests](https://open-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 brand by property_id.](https://open-api-docs.guesty.com/reference/externalintegrationscontroller_getbrandbyproperty.md): Http endpoint to retrieve brandings by property id.
- [Assign listings to Business Models](https://open-api-docs.guesty.com/reference/assignlistingcontroller_update.md): Assign provided listings to appropriate Business model
- [Get Business Models](https://open-api-docs.guesty.com/reference/businessmodelsoacontroller_index.md): Get list of Business Models by accountId
- [Get categories list](https://open-api-docs.guesty.com/reference/categoriescontroller_getcategories.md): Retrieve a paginated list of categories with optional filtering. Supports filtering by name.
- [Get all journal entries](https://open-api-docs.guesty.com/reference/journalentriescontroller_getall.md): Retrieves all journal entries matching the specified parameters
- [Get recognized journal entries](https://open-api-docs.guesty.com/reference/journalentriescontroller_getrecognized.md): Retrieves recognized journal entries matching the specified parameters
- [Get owner working capital](https://open-api-docs.guesty.com/reference/ownerscontroller_retrieve.md): Get latest owner working capital by owner ID.
- [Update owner working capital](https://open-api-docs.guesty.com/reference/ownerscontroller_update.md): Update owner working capital by owner ID.
- [Get folio balances](https://open-api-docs.guesty.com/reference/reservationscontroller_foliobalances.md): Get folio balances by reservation ID. For each reservation get the accounting folio balances per ledger. Balances represent current and future entries.
- [Create owner charge per owner](https://open-api-docs.guesty.com/reference/transactionscontroller_createcharge.md): Create charge for provided owner.
- [Create owner charges by listing](https://open-api-docs.guesty.com/reference/transactionscontroller_createchargebylisting.md): Create an owner charge for the provided listing. This will apply to all owners unless you include a given ownerId.
- [Create expense](https://open-api-docs.guesty.com/reference/transactionscontroller_createexpense.md): Create expense for provided vendor. The expense will be created only for the specified owner and will not be split between all the listing ownerships.
- [Create expense by listing](https://open-api-docs.guesty.com/reference/transactionscontroller_createexpensebylisting.md): Create an expense for the provided listing. This will apply to all owners unless you include a given ownerId.
- [Delete Custom Field](https://open-api-docs.guesty.com/reference/delete_accounts-id-custom-fields-field-id.md)
- [Get Custom Field](https://open-api-docs.guesty.com/reference/get_accounts-id-custom-fields-field-id.md)
- [Get All Custom Fields](https://open-api-docs.guesty.com/reference/get_accounts-id-custom-fields.md)
- [Get account details of current user.](https://open-api-docs.guesty.com/reference/get_accounts-me.md)
- [Create new custom field](https://open-api-docs.guesty.com/reference/post_accounts-id-custom-fields.md)
- [Update custom field](https://open-api-docs.guesty.com/reference/put_accounts-id-custom-fields.md)
- [Delete existing additional fee](https://open-api-docs.guesty.com/reference/delete_additional-fees-id.md)
- [Get list of additional fees for account](https://open-api-docs.guesty.com/reference/get_additional-fees-account.md)
- [Get list of additional fees for listing](https://open-api-docs.guesty.com/reference/get_additional-fees-listing-listingid.md)
- [Update existing additional fee](https://open-api-docs.guesty.com/reference/patch_additional-fees-id.md)
- [Create additional fee on account level](https://open-api-docs.guesty.com/reference/post_additional-fees-account.md)
- [Add upsell fee to inquiry rate plans quotes [Beta]](https://open-api-docs.guesty.com/reference/post_additional-fees-inquiries-inquiryid-upsells.md): Add upsell fee to inquiry rate plans quotes. Add upsell fee id multiple times if you want to add the same upsell fee multiple times. To remove the upsell fee exclude the ID from an array [Beta]
- [Create additional fee on listing level](https://open-api-docs.guesty.com/reference/post_additional-fees-listing-listingid.md)
- [Calculate additional fee amount for quote [Beta]](https://open-api-docs.guesty.com/reference/post_additional-fees-quotes-quoteid-amount.md): Calculate additional fee amount for quote [Beta]
- [Geocode Location by Full Address](https://open-api-docs.guesty.com/reference/addresscontroller_geocodeaddress.md): Converts the full address into latitude and longitude coordinates and populates individual address fields.
- [Retrieve Property Address](https://open-api-docs.guesty.com/reference/addresscontroller_getaddress.md): Get the listing address of the given property.
- [Update Property Address](https://open-api-docs.guesty.com/reference/addresscontroller_updateaddress.md): Edit the address of a given property. If it is a multi-unit, all sub-units will be updated too.
- [Update Complex Address](https://open-api-docs.guesty.com/reference/addresscontroller_updatecomplexaddress.md): Edit a complex's address. All children will be updated too.
- [Retrieve Airbnb listing expectations](https://open-api-docs.guesty.com/reference/listingexpectationscontroller_getlistingexpectations.md): Get listing expectations for Airbnb channel by Guesty listing ID.
- [Upsert Airbnb listing expectations](https://open-api-docs.guesty.com/reference/listingexpectationscontroller_upsertlistingexpectations.md): Upsert listing expectations for Airbnb channel by Guesty listing ID.
- [List closed airbnb resolutions for reservation](https://open-api-docs.guesty.com/reference/airbnbresolutionscontroller_listresolutions.md): List closed airbnb resolutions for reservation.
- [Retrieve Property Amenities](https://open-api-docs.guesty.com/reference/amenitiescontroller_getforunittype.md): Retrieve a property's amenities.
- [Set Amenities For Property](https://open-api-docs.guesty.com/reference/amenitiescontroller_setamenitiesforproperty.md): Set selected amenities list to the property
- [Get a List Of All Available Amenity Groups](https://open-api-docs.guesty.com/reference/getamenitiesgroups.md): Get a list of all available amenity groups
- [Get a List of All Supported Amenities](https://open-api-docs.guesty.com/reference/getsupportedamenities.md): Get a list of all supported amenities, including their names, groups and channels
- [Get calendar block logs](https://open-api-docs.guesty.com/reference/calendarlogsopenapicontroller_getcalendarlogs.md): Retrieves a list of block logs based on the specified filters.
- [Create exported calendar link](https://open-api-docs.guesty.com/reference/exportedcalendaropenapicontroller_createexportedcalendar.md): When you export your Guesty calendar to an external service, the events from the Guesty calendar will block the external calendar. You must create an exported calendar entity to export data from Guesty via the iCalendar link. This entity stores the settings used during the export process, such as the URL, state, and adjustments. Once the entity is created, the export sync process will be triggered. Please note that you can only have one exported calendar per listing. After posting your request, you will receive an exported calendar descriptor, which includes the URL property. You will use this URL in your other services to pull data from Guesty.
- [Delete exported calendar](https://open-api-docs.guesty.com/reference/exportedcalendaropenapicontroller_deleteexportedcalendar.md): Keep in mind - when you remove an exported calendar, any services that use its URL will encounter a 404 error. To permanently delete the exported calendar, use the following request.
- [Get active exported calendar](https://open-api-docs.guesty.com/reference/exportedcalendaropenapicontroller_getexportedcalendar.md): Any listing can have only 1 exported calendar, composed by Guesty. You can use the following request to retrieve an active exported-calendar for a specified listing. Please, note, the response body will contain either an empty list, or a list with a single item - the exported calendar itself. You can use this endpoint to get currently active exported calendar, if you do not have its id.
- [Get a specific exported calendar](https://open-api-docs.guesty.com/reference/exportedcalendaropenapicontroller_getexportedcalendarbyid.md): Should return the state of an exported calendar entity by its id. If an exported calendar was removed, you will receive an error.
- [Update exported calendar](https://open-api-docs.guesty.com/reference/exportedcalendaropenapicontroller_updateexportedcalendar.md): If adjustment values are updated, the export sync process will be triggered. Use this request to update events adjustment of your exported Guesty calendar. Please note you can update only the parameters listed below.
- [Import a calendar](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_createimportedcalendar.md): To import external calendar events into Guesty Calendar via the iCalendar link, you must first create an imported-calendar entity. This entity stores the import settings, such as the URL, calendar name, state, and events adjustment. Once the entity is created, the import sync process will be initiated.
- [Delete imported calendar](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_deleteimportedcalendar.md): You can remove imported calendar with one of the following behaviors (strategies) regarding existing imported events.
- [Get imported calendar by id](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_getimportedcalendarbyid.md): To retrieve data for a specific imported calendar, including iCalendar name, URL, state & events adjustment, use the following request
- [Get imported calendars list](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_getimportedcalendars.md): To retrieve a list of all imported calendars, use the following request.
- [Unsync imported calendar](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_pauseimportedcaledar.md): You can manually pause or resume the import process with the following requests. Once the imported calendar is resumed, the import sync process will be triggered.
- [Resume imported calendar sync](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_resumeimportedcaledar.md): You can manually pause or resume the import process with the following requests. Once the imported calendar is resumed, the import sync process will be triggered.
- [Update imported calendar](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_updateimportedcalendar.md): If any adjustments are made to the values, the import sync process will be automatically triggered. You can use this request to update the URL, name, or events adjustment of a specific imported calendar ID. To pause or resume the import process, navigate to "Pause/Resume Imported-Calendar Sync." Please note that you can only update the allowed properties that are listed below.
- [Retrieve the calendar for a single listing](https://open-api-docs.guesty.com/reference/get_availability-pricing-api-calendar-listings-id.md): Use this endpoint to retrieve daily calendar availability and pricing for a given listing ID and date range. IMPORTANT: Multi-unit calendar availability is determined by unit allotment, not its `status` field. To calculate if a multi-unit has availability, use the following formula: ``` const isAvailable = _.isNumber(currentDay.allotment)? currentDay.allotment > 0 : currentDay.status === 'available'; ```
- [Retrieve the optimized calendar for a single listing](https://open-api-docs.guesty.com/reference/get_availability-pricing-api-calendar-listings-minified-listingid.md): Use this endpoint to retrieve daily calendar availability and pricing for a given listing ID and date range with optimized response format. **View Parameter Behavior:** - `view=compact` (default): Returns minimal data without `blockIds` array and detailed `blocks` object for better performance - `view=full`: Returns complete data including `blockIds` array for each calendar day and detailed `blocks` object with full block information IMPORTANT: Multi-unit calendar availability is determined by unit allotment, not its `status` field. To calculate if a multi-unit has availability, use the following formula: ``` const isAvailable = _.isNumber(currentDay.allotment)? currentDay.allotment > 0 : currentDay.status === 'available'; ```
- [Retrieve calendars for multiple listings](https://open-api-docs.guesty.com/reference/get_availability-pricing-api-calendar-listings.md): Use this endpoint to retrieve calendar availability and pricing for multiple listings according to a date range.
- [Update the calendar for a single listing](https://open-api-docs.guesty.com/reference/put_availability-pricing-api-calendar-listings-id.md): Set the nightly rate, minimum stay and availability of any calendar date per listing.
- [Update calendar for multiple listings](https://open-api-docs.guesty.com/reference/put_availability-pricing-api-calendar-listings.md): Use this endpoint to set availability and pricing for multiple listings across a range of dates. IMPORTANT: - It is strongly suggested updating a single unique listing ID in a single HTTP request, despite the fact the API does support receiving different listing IDs. - Max allowed days to be updated - 730 (~2 years) - Strongly suggested to not update the same listing ID in parallel. - To decrease response time, send fewer date periods.
- [Get account channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_getaccountchannelcommission.md): Get account channel commission.
- [Get account channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_getaccountchannelcommission1.md): Get account channel commission.
- [Get listings channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_getlistingschannelcommission.md): Get channel commission from multiple listings.
- [Get listings channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_getlistingschannelcommission1.md): Get channel commission from multiple listings.
- [Update account channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_updateaccountchannelcommission.md): This endpoint allows you to send Guesty an updated amount for channel commissions. Providing an amount to an existing integration object or manual source will update its channel commission value. If the integration object or manual source do not exist, they will be added. example for bookingCom: { bookingCom: {tax: 10, commission: {value: 5, of: ["ACCOMMODATION_FARE"]}}} Applying your channel commission on fees & taxes is currently in beta.
- [Update account channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_updateaccountchannelcommission1.md): This endpoint allows you to send Guesty an updated amount for channel commissions. Providing an amount to an existing integration object or manual source will update its channel commission value. If the integration object or manual source do not exist, they will be added. example for bookingCom: { bookingCom: {tax: 10, commission: {value: 5, of: ["ACCOMMODATION_FARE"]}}} Applying your channel commission on fees & taxes is currently in beta.
- [Update listings channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_updatelistingschannelcommission.md): This endpoint allows you to send Guesty an updated amount for channel commissions. Providing an amount to an existing integration object or manual source will update its channel commission value. If the integration object or manual source do not exist, they will be added. example for bookingCom: {channelCommissions: [{listingId: "923892d53f4f56cfcb25586d", bookingCom: {tax: 10, commission: {value: 5, of: ["ACCOMMODATION_FARE"]}}}]} Applying your channel commission on fees & taxes is currently in beta.
- [Update listings channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_updatelistingschannelcommission1.md): This endpoint allows you to send Guesty an updated amount for channel commissions. Providing an amount to an existing integration object or manual source will update its channel commission value. If the integration object or manual source do not exist, they will be added. example for bookingCom: {channelCommissions: [{listingId: "923892d53f4f56cfcb25586d", bookingCom: {tax: 10, commission: {value: 5, of: ["ACCOMMODATION_FARE"]}}}]} Applying your channel commission on fees & taxes is currently in beta.
- [Create a new complex](https://open-api-docs.guesty.com/reference/addcomplex.md): Create a new complex and return the ID of the newly created complex
- [Assign propertyIds to a complex](https://open-api-docs.guesty.com/reference/complexescontroller_assigncomplexpropertyids.md): Assign propertyIds to a specific complex based on the complexId, and returns the assigned values
- [Get complex](https://open-api-docs.guesty.com/reference/complexescontroller_getcomplexbyid.md): Get a specific complex based on the complexId
- [Delete complex](https://open-api-docs.guesty.com/reference/complexescontroller_removecomplex.md): Deletes a specific complex based on the complexId
- [Un-Assign propertyIds from a complex](https://open-api-docs.guesty.com/reference/complexescontroller_unassigncomplexpropertyids.md): Unassign propertyIds from a specific complex based on the complexId, and returns the unassigned values
- [Update complex details](https://open-api-docs.guesty.com/reference/complexescontroller_updatecomplexdetails.md): Updates the details of a specific complex based on the complexId, and returns the modified values
- [Get a list of all complexes](https://open-api-docs.guesty.com/reference/getallcomplexes.md): Get a list of all complexes, including their IDs, titles, nicknames, propertyIds, and tags
- [Delete Custom Field from property](https://open-api-docs.guesty.com/reference/delete.md): Delete a specific custom field value from property
- [List Custom Fields per Property](https://open-api-docs.guesty.com/reference/getall.md): Obtain a list of custom fields that are set on the selected property.
- [Get Custom Field from Selected Property](https://open-api-docs.guesty.com/reference/getbyfieldid.md): Retrieve a specific custom field for a select property using the custom field ID.
- [Update property Custom Fields](https://open-api-docs.guesty.com/reference/updatemany.md): Update many custom fields of property at once. It will only update custom fields of property, if You need to remove other fields please use DELETE endpoint
- [Add attachments to expense](https://open-api-docs.guesty.com/reference/expensescontroller_addattachments.md): Adds one or more attachments to an existing expense without replacing previously added ones. Accepts up to 10 attachments per request. Each attachment requires: url, urlThumbnail, extension, and fileName.
- [Cancel expense](https://open-api-docs.guesty.com/reference/expensescontroller_cancelexpense.md): Cancels an expense by its ID. Sets the expense status to CANCELED, deletes all associated Journal Entries. Supports cancellation of expenses in SCHEDULED, SUBMITTED, or INSUFFICIENT_FUNDS status. Rejects cancellation for PAID or already CANCELED expenses. Rejects cancellation when any associated Journal Entry is locked, reconciled, or disbursed.
- [Create expense](https://open-api-docs.guesty.com/reference/expensescontroller_createexpense.md): Creates a new manual expense. Validates the expense date against the lock period and rejects creation if the date is locked. Required fields: name, expenseDate, categoryId, chargeableAmount, currency, paymentShareAmountType, revenueShareAmountType, shares, and shareOption. Either owners or listingIds must be provided (mutually exclusive). Type (`owner_charge` or `pmc_expense`) is optional. If omitted, it is derived from the shares array: `PMC_EXPENSE` when PMC pays (or both `PMC` and `Owner` pay), `OWNER_CHARGE` when only `Owner` pays. If provided, it must match the calculated type from shares.
- [Delete attachment from expense](https://open-api-docs.guesty.com/reference/expensescontroller_deleteattachment.md): Deletes a single attachment from an existing expense by its attachment ID. Returns the updated expense after the attachment is removed.
- [Get expense by ID](https://open-api-docs.guesty.com/reference/expensescontroller_getexpensebyid.md): Retrieves a specific expense by its ID. Returns expense details including current version (amount, status, dates) and attachments.
- [Get expenses with filtering](https://open-api-docs.guesty.com/reference/expensescontroller_getexpenses.md): Retrieves expenses with optional filtering and pagination. Filters by status (comma-separated), category, vendor, owner, listing, reservation IDs, and date ranges. Returns up to 100 items per page. Defaults to 50 items, sorted by creation date descending.
- [Create a group reservation](https://open-api-docs.guesty.com/reference/groupreservationsopenapicontroller_create.md): This endpoint allows the creation of a group reservation, based on an array of quotes
- [Get group reservation by group id](https://open-api-docs.guesty.com/reference/groupreservationsopenapicontroller_getgroupreservation.md): Get group reservation by group id, including it's sub reservations (up to 25 sub reservations)
- [Create a new group](https://open-api-docs.guesty.com/reference/creategroup.md): Create a combo property or property variant (duplicates) to organize related listings with a designated primary listing. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants). Check out our [Help Center](https://help.guesty.com/hc/en-gb/articles/33014581967901-Pilot-Managing-combo-properties-and-property-variants) to learn more about these property types.
- [Delete group](https://open-api-docs.guesty.com/reference/deletegroup.md): Delete a combo property or property variant (group) and disassociate all its members. All associated Smart Calendar Rules will be removed. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants). Check out our [Help Center](https://help.guesty.com/hc/en-gb/articles/33014581967901-Pilot-Managing-combo-properties-and-property-variants) to learn more about these property types.
- [Get group by ID](https://open-api-docs.guesty.com/reference/getgroup.md): Retrieve detailed information about a specific combo property or property variant (group), including all its members. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants). Check out our [Help Center](https://help.guesty.com/hc/en-gb/articles/33014581967901-Pilot-Managing-combo-properties-and-property-variants) to learn more about these property types.
- [List groups](https://open-api-docs.guesty.com/reference/listgroups.md): Retrieve a paginated list of combo properties and property variants (groups) for the account. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants). Supports optional filtering by group type. Check out our [Help Center](https://help.guesty.com/hc/en-gb/articles/33014581967901-Pilot-Managing-combo-properties-and-property-variants) to learn more about these property types.
- [Update group](https://open-api-docs.guesty.com/reference/updategroup.md): Modify a combo property or property variant (group) by adding or removing members, or changing the primary listing. Provide the complete list of members after the update. The term group refers to both types: COMBO (combo properties) and DUPLICATES (property variants). Check out our [Help Center](https://help.guesty.com/hc/en-gb/articles/33014581967901-Pilot-Managing-combo-properties-and-property-variants) to learn more about these property types.
- [Get check-in form summary by reservation id](https://open-api-docs.guesty.com/reference/guestappopenapicontroller_getcifsummarydetails.md): Get url and filename of the check-in form summary. Url is valid for 1 hour.
- [List guest's payment methods](https://open-api-docs.guesty.com/reference/get_guests-id-payment-methods.md): Retrieve payment method list by guest id
- [Create guest](https://open-api-docs.guesty.com/reference/guestsopenapicontroller_createguest.md): Create guest
- [Get guest by id](https://open-api-docs.guesty.com/reference/guestsopenapicontroller_getguest.md): Get guest by id
- [Get guests list](https://open-api-docs.guesty.com/reference/guestsopenapicontroller_getguestslist.md): Get guests list
- [Update guest](https://open-api-docs.guesty.com/reference/guestsopenapicontroller_updateguest.md): Update guest
- [Create guest payment method](https://open-api-docs.guesty.com/reference/post_guests-id-payment-methods.md)
- [Get guest code](https://open-api-docs.guesty.com/reference/reservationaccesscodecontroller_getlocksandcodesbyreservation.md): Get guest code data for reservations with future check-out times, by reservation ID. Note: The main guest codes are codes with "purpose" set to "GUEST". Codes with "purpose" set to "GUEST_BACKUP" are codes to share with guests in case the "GUEST" code has errors, starting from the check-in day. "GUEST_BACKUP" codes are a dynamic pool of codes associated with reservations on check-in day. When fetching a "GUEST_BACKUP" code before the check-in day, the code is not guaranteed to stay the same until the check-in day.
- [Retrieve unit-type house-rules](https://open-api-docs.guesty.com/reference/get_properties-house-rules-unit-type-unittypeid.md)
- [List house rules](https://open-api-docs.guesty.com/reference/get_properties-house-rules.md)
- [Update multiple unit-type house-rules](https://open-api-docs.guesty.com/reference/post_properties-house-rules.md)
- [Update unit-type house-rules](https://open-api-docs.guesty.com/reference/put_properties-house-rules-unit-type-unittypeid.md)
- [Get posts (by conversation id)](https://open-api-docs.guesty.com/reference/get_communication-conversations-conversationid-posts.md)
- [Get conversation by id](https://open-api-docs.guesty.com/reference/get_communication-conversations-conversationid.md)
- [Get conversations](https://open-api-docs.guesty.com/reference/get_communication-conversations.md): Get conversations
- [Post msg to conversation without sending it](https://open-api-docs.guesty.com/reference/post_communication-conversations-conversationid-posts.md)
- [Post msg(Send new msg)](https://open-api-docs.guesty.com/reference/post_communication-conversations-conversationid-send-message.md): Owners conversations do not support airbnb2 module type, messages that sent with platform module type will be sent through Email.
- [Get integration](https://open-api-docs.guesty.com/reference/get_integrations-id.md): Use this endpoint to retrieve all a single account integration.
- [List all integrations](https://open-api-docs.guesty.com/reference/get_integrations.md): Retrieve a list of all your account integrations.
- [Create integration](https://open-api-docs.guesty.com/reference/post_integrations.md): Create an integration.
- [Update integration](https://open-api-docs.guesty.com/reference/put_integrations-id.md): Selectively update fields of single account integration.
- [Create Invoice Item](https://open-api-docs.guesty.com/reference/invoiceitemscontroller_createinvoiceitem.md): Create Invoice Item
- [Create external link](https://open-api-docs.guesty.com/reference/createexternallink.md): Adds a new link to the property. url must include protocol (e.g. https://). name is the label shown to users (e.g. "House manual"). The new link is appended to the end; use PUT :propertyId/order to change order.
- [Delete external link](https://open-api-docs.guesty.com/reference/deleteexternallink.md): Removes one external link from the property. linkId is from the list (GET) or a create response. Returns 204 with no body. The id cannot be used afterward.
- [List external links](https://open-api-docs.guesty.com/reference/listexternallinks.md): Returns all external links for the given property (listing). Each item has id, url, and name. Use the id values for update (PUT), delete (DELETE), or reorder (PUT order). Empty array if the property has no links yet.
- [Reorder external links](https://open-api-docs.guesty.com/reference/reorderexternallinks.md): Sets the display order of links. Send linkIds in the order you want (first id = first link). Only the ids you send are moved to the top in that order; any other links for the property stay at the bottom unchanged. All ids must exist for this property; no duplicates. Use GET to obtain current ids.
- [Update external link](https://open-api-docs.guesty.com/reference/updateexternallink.md): Updates URL and/or display name of one link. Include only the fields you want to change (url, name, or both). linkId is from the list (GET) or a create response.
- [Delete a listing](https://open-api-docs.guesty.com/reference/delete_listings-id.md)
- [Delete listing's custom fields](https://open-api-docs.guesty.com/reference/delete_listings-listing-id-custom-fields-field-id.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/delete
- [Retrieve listing Financials](https://open-api-docs.guesty.com/reference/get_financials-listing-id.md)
- [List all cities](https://open-api-docs.guesty.com/reference/get_listings-cities.md)
- [Get custom field-Listings](https://open-api-docs.guesty.com/reference/get_listings-id-custom-fields-field-id.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/getbyfieldid
- [Get all listing's custom fields](https://open-api-docs.guesty.com/reference/get_listings-id-custom-fields.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/getall
- [Retrieve a listing's paymentProviderId](https://open-api-docs.guesty.com/reference/get_listings-id-fields-paymentproviderid.md): providerAccountId is important! - this is how you identify with Stripe once the clearing payment
- [Retrieve a listing](https://open-api-docs.guesty.com/reference/get_listings-id.md)
- [List all tags](https://open-api-docs.guesty.com/reference/get_listings-tags.md)
- [Retrieve all listings](https://open-api-docs.guesty.com/reference/get_listings.md)
- [Export as CSV](https://open-api-docs.guesty.com/reference/post_listings-csv.md): Same as GET /listings but results are returned as a downloadable csv file
- [Send results in email](https://open-api-docs.guesty.com/reference/post_listings-email.md): Same as /listings but results are sent as an email
- [Create a listing](https://open-api-docs.guesty.com/reference/post_listings.md)
- [Update listing Financials](https://open-api-docs.guesty.com/reference/put_financials-listing-id.md): Only accessible to Admin or User tokens.
- [Update listings availability settings](https://open-api-docs.guesty.com/reference/put_listings-id-availability-settings.md)
- [Update listing's Custom Fields](https://open-api-docs.guesty.com/reference/put_listings-id-custom-fields.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/updatemany
- [Update a listing](https://open-api-docs.guesty.com/reference/put_listings-id.md)
- [[Beta] Create Description Set.](https://open-api-docs.guesty.com/reference/createdescriptionset.md): Create a new Description Set.
- [[Beta] Delete Description Set.](https://open-api-docs.guesty.com/reference/deletedescriptionset.md): Delete the Description Set.
- [Retrieve a list of supported channels.](https://open-api-docs.guesty.com/reference/getchannels.md): Retrieve a list of supported channels.
- [[Beta] Get a list of description sets.](https://open-api-docs.guesty.com/reference/getdescriptionsets.md): Retrieve a list of description sets for a specific Listing.
- [Get a list of translation fields](https://open-api-docs.guesty.com/reference/getfields.md): Retrieve a list of translation fields for a specific language slug or all languages
- [[Beta] Get a list of translation fields per channel](https://open-api-docs.guesty.com/reference/getfieldsperchannel.md): Get a list of translation fields for a specific language slug or all languages per channel.
- [[Beta] Get a list of translation fields per description set.](https://open-api-docs.guesty.com/reference/getfieldsperdescriptionset.md): Get a list of translation fields for a specific language slug or all languages per description set.
- [Retrieve a list of supported languages.](https://open-api-docs.guesty.com/reference/getlanguages.md): Retrieve a list of supported languages.
- [[Beta] Retrieve a list of supported languages for specific listing](https://open-api-docs.guesty.com/reference/getpropertylanguages.md): Retrieve a list of supported languages for specific listing by listing id
- [[Beta] Update Description Set.](https://open-api-docs.guesty.com/reference/updatedescriptionset.md): Update the Description Set.
- [Upsert translation](https://open-api-docs.guesty.com/reference/upsertfields.md): Upsert a new translation for specific listing and language slug.
- [[Beta] upsert supported languages for specific listing](https://open-api-docs.guesty.com/reference/upsertpropertylanguages.md): Upsert supported languages for specific listing
- [GET Rate Plan Calendar](https://open-api-docs.guesty.com/reference/aricalendarcontroller_get.md): Retrieves the rate plan's rates, availability and inventory by calendar date.
- [Upsert Rate Plan ARI Calendar](https://open-api-docs.guesty.com/reference/aricalendarcontroller_upsert.md): Set rate plan calendar availability, rates and inventory.
- [Create a Rate Plan](https://open-api-docs.guesty.com/reference/rateplancontroller_create.md): Creates a Rate Plan. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Get All Rate Plans](https://open-api-docs.guesty.com/reference/rateplancontroller_getall.md): Retrieves all rate plans by channel. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Get a Rate Plan by ID](https://open-api-docs.guesty.com/reference/rateplancontroller_getbyid.md): Retrieves a rate plan by querying its ID. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Get Rate Plans by Property](https://open-api-docs.guesty.com/reference/rateplancontroller_getbylisting.md): Retrieve rate plans by the listing ID. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Assign Properties to a Rate Plan](https://open-api-docs.guesty.com/reference/rateplancontroller_initassignlistings.md): Assigns listings to a rate plan. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Unassign Properties from a Rate Plan](https://open-api-docs.guesty.com/reference/rateplancontroller_initunassignlistings.md): Removes listings from a rate plan. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [patch rate plan](https://open-api-docs.guesty.com/reference/rateplancontroller_patch.md): patch rate plan. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Remove a Rate Plan](https://open-api-docs.guesty.com/reference/rateplancontroller_remove.md): Deletes an existing rate plan. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Update a Rate Plan](https://open-api-docs.guesty.com/reference/rateplancontroller_update.md): Updates an existing rate plan. Currently in pilot, the Rate Plans API allows the creation and management of independent rate plans that are not visible or editable within the Guesty UI. This API is available exclusively for Booking.com and direct reservations. To participate in the pilot, customers should contact Guesty for an eligibility review and to receive detailed information on potential limitations and risks.
- [Create a document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_create.md): Create a document
- [Delete document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_delete.md): Delete document
- [Download document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_download.md): Download document
- [Get document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_get.md): Get document
- [Get list of documents](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_getall.md): Get list of documents
- [Update document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_update.md): Update document (supports partial update)
- [Retrieve an owner reservation](https://open-api-docs.guesty.com/reference/get_owners-reservations-id.md): This allows you to obtain details about a specific owner's reservation.
- [List owners reservations](https://open-api-docs.guesty.com/reference/get_owners-reservations.md): Retrieve a list of all owner reservations. This endpoint is filterable.
- [Update an owner reservation](https://open-api-docs.guesty.com/reference/put_owners-reservations-id.md): Use this request to alter an owner's reservation.
- [Create multiple owners with assigned listings](https://open-api-docs.guesty.com/reference/ownersbulkopenapicontroller_createbulk.md): Create multiple owners with assigned listings
- [Create an owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_create.md): Create an owner
- [Create owner guest](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_createownerguest.md): Create a new guest for an owner and update the owner guestId
- [Delete owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_delete.md): Delete owner
- [Get owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_get.md): Get owner
- [Get list of owners](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_getall.md): Get list of owners
- [Update owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_update.md): Update owner (supports partial update)
- [Get listing ownerships](https://open-api-docs.guesty.com/reference/listingownershipsopenapicontroller_get.md): Get listing ownerships
- [Set ownerships to listing](https://open-api-docs.guesty.com/reference/listingownershipsopenapicontroller_set.md): Set ownerships to listing
- [Get owner listings ownerships](https://open-api-docs.guesty.com/reference/ownerownershipsopenapicontroller_get.md): Get owner listings ownerships
- [Get default payment provider](https://open-api-docs.guesty.com/reference/getdefaultprovider.md)
- [Get payment provider by id](https://open-api-docs.guesty.com/reference/getpaymentprovider.md)
- [Get payment provider by listing id](https://open-api-docs.guesty.com/reference/getpaymentproviderbylisting.md)
- [Get provider stats](https://open-api-docs.guesty.com/reference/getstats.md)
- [Get summary ](https://open-api-docs.guesty.com/reference/getsummary.md)
- [Assign listings to Stripe account](https://open-api-docs.guesty.com/reference/post_payment-providers-id-assign-listings.md)
- [Get payouts reconciliation data from Guesty Pay providers](https://open-api-docs.guesty.com/reference/payoutsreconciliationcontroller_getpayoutsreconciliation.md): Retrieves payouts reconciliation reports from for Guesty Pay providers. Supports filtering by: - date range (startDate and endDate) - payoutId - subAccountId - reservation confirmation code (mutually exclusive with all other filters) Date range is mandatory unless reservationConfirmationCode is provided.
- [Get transactions from Guesty Pay providers](https://open-api-docs.guesty.com/reference/reportcontroller_gettransactionreport.md): The endpoint retrieves transaction data from Guesty Pay providers The endpoint supports filtering by: - date range (startDate and endDate) - reservation confirmation code - subAccountId However, you can not use the reservationConfirmationCode filter together with other filters. The date range filter is mandatory if you do not use the reservationConfirmationCode filter.
- [Bulk create owner payout methods](https://open-api-docs.guesty.com/reference/openapicontroller_createbulkownerpayoutmethods.md): Creates payout methods for multiple owners. Returns per-item success/failure results.
- [Create owner payout method](https://open-api-docs.guesty.com/reference/openapicontroller_createownerpayoutmethod.md): Creates a payout method for the given owner.
- [Get owner payout method](https://open-api-docs.guesty.com/reference/openapicontroller_getownerpayoutmethods.md): Returns the payout method configured for the given owner.
- [Update owner payout method](https://open-api-docs.guesty.com/reference/openapicontroller_updateownerpayoutmethod.md): Updates the payout method for the given owner.
- [Create a new contact](https://open-api-docs.guesty.com/reference/openapicontactscontroller_create.md): Creates a new contact in the phonebook with the provided information.
- [List all contacts](https://open-api-docs.guesty.com/reference/openapicontactscontroller_findall.md): Retrieves a paginated list of all contacts for the authenticated user's account.
- [Get a specific contact](https://open-api-docs.guesty.com/reference/openapicontactscontroller_findone.md): Retrieves a specific contact by its unique ID.
- [Delete a contact](https://open-api-docs.guesty.com/reference/openapicontactscontroller_remove.md): Permanently deletes a contact from the phonebook.
- [Update a contact](https://open-api-docs.guesty.com/reference/openapicontactscontroller_update.md): Updates an existing contact with the provided information.
- [Pre-approve an existing inquiry (Airbnb)](https://open-api-docs.guesty.com/reference/post_reservations-api-reservations-reservationid-pre-approve.md): Use this call to send a [pre-approval](https://www.airbnb.com/help/article/35).
- [Create a total amount price adjustments](https://open-api-docs.guesty.com/reference/priceadjustmentscontroller_createmanualpriceadjustments.md): Use to create a manual price adjustments (increase or decrease) for a reservation.
- [Get all total amount price adjustments for a reservation](https://open-api-docs.guesty.com/reference/priceadjustmentscontroller_getalltotalamountpriceadjustment.md): Get all total amount price adjustments for a reservation
- [Assign Properties to a Promotion.](https://open-api-docs.guesty.com/reference/promotioncontroller_assignlistings.md): Assigns properties to participate in a promotion.
- [Get promotion listings](https://open-api-docs.guesty.com/reference/promotioncontroller_getassignedlistingids.md): Get listing IDs assigned to a promotion.
- [Get All Promotions](https://open-api-docs.guesty.com/reference/promotioncontroller_getlist.md): Retrieves all eligible, ongoing, and expired promotions on the account.
- [Unassign Properties from a Promotion.](https://open-api-docs.guesty.com/reference/promotioncontroller_unassignlistings.md): Removes properties from participating in the promotion.
- [Get property logs](https://open-api-docs.guesty.com/reference/getpropertylogs.md): Retrieve logs for a specific property with optional filtering and pagination
- [Create Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_createvirtualtour.md): Insert a virtual tour URL for a specific property
- [Delete Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_deletevirtualtour.md): Remove the virtual tour URL from a specific property
- [Get Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_getvirtualtour.md): Retrieve the virtual tour URL for a specific property
- [Update Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_upsertvirtualtour.md): Update the virtual tour URL for a specific property
- [Delete a Photo](https://open-api-docs.guesty.com/reference/delete1.md): Delete a specific photo from a given property.
- [Replace photo or edit caption without changing order or room assignment.](https://open-api-docs.guesty.com/reference/edit.md): Edit a Photo
- [Retrieve all photos for a given listing.](https://open-api-docs.guesty.com/reference/get.md): Retrieve a list of all the photos for a property.
- [Change the photo order on a property](https://open-api-docs.guesty.com/reference/order.md): Alter the order of the existing property photos. All listed photos will be placed first, and the rest will be placed at the end.
- [Upload a photo to property using file blob](https://open-api-docs.guesty.com/reference/uploadbyblob.md): Upload a new property photo using a file blob. Supports image files.
- [Add new photos to property](https://open-api-docs.guesty.com/reference/uploadbyurls.md): Upload new property photos using URLs. Ensure the repositories are accessible to Guesty.
- [Add coupons to an existing quote](https://open-api-docs.guesty.com/reference/quotesopenapicontroller_changecoupons.md): Add coupons to an existing quote
- [Create a Quote](https://open-api-docs.guesty.com/reference/quotesopenapicontroller_create.md): This endpoint allows the creation of a price quote for a reservation. It requires details such as the listing ID, check-in and check-out dates, and guest count. The response includes detailed information about the quote, including rates, promotions, and applicable fees.
- [Create multiple quotes for reservation](https://open-api-docs.guesty.com/reference/quotesopenapicontroller_createmultiple.md): This endpoint allows the creation of multiple price quotes for a reservation.
- [Retrieve a Quote by ID](https://open-api-docs.guesty.com/reference/quotesopenapicontroller_getquote.md): This endpoint allows retrieval of a specific quote using its unique ID. It is used to fetch details of a previously created quote. If the quote has expired, the endpoint returns an error message indicating that the quote is expired and suggests creating a new quote.
- [Retrieve Property's Rate Strategy.](https://open-api-docs.guesty.com/reference/ratestrategycontroller_getbyunittypeid.md): Use this endpoint to retrieve the property's associated rate strategy settings.
- [Retrieve All Rate Strategies.](https://open-api-docs.guesty.com/reference/ratestrategycontroller_getlist.md): Use this endpoint to retrieve an account's associated rate strategy settings.
- [Create a reservation comment](https://open-api-docs.guesty.com/reference/reservationcommentsopenapicontroller_createcomment.md): Create an internal reservation comment or reply
- [Delete a reservation comment](https://open-api-docs.guesty.com/reference/reservationcommentsopenapicontroller_deletecomment.md): Soft-delete an internal reservation comment. Only the comment author (from the OAuth token) may delete.
- [List reservation comments](https://open-api-docs.guesty.com/reference/reservationcommentsopenapicontroller_getcomments.md): Retrieve internal reservation comments for a reservation, including top-level threads and nested replies.
- [Update a reservation comment](https://open-api-docs.guesty.com/reference/reservationcommentsopenapicontroller_updatecomment.md): Update an internal reservation comment. Only the comment author (from the OAuth token) may edit.
- [Get reservation logs](https://open-api-docs.guesty.com/reference/reservationslogsopenapicontroller_getreservationlogs.md): Retrieve a paginated list of activity log entries for a specific reservation.
- [Approve a channel reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_approvechannelreservation.md): Approve a channel reservation that is in 'reserved' status. This endpoint creates an approval request that will be processed asynchronously. The reservation must be from a channel (like Airbnb, Booking.com, etc.) and in 'reserved' status to be approved.
- [Change Reservation Guest Stay Status](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_changestay.md): Change the guest stay status of the reservation
- [Create a mid-stay](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_createmidstay.md): Relocate guests to a different listing during their stay
- [Create a confirmed owner reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_createownerconfirmed.md): Create a confirmed owner reservation - This endpoint enables the creation of an Owner Reservation instantly with minimal required input. It is designed for simplicity and speed, focusing on essential details only. Behind the scenes, it will create a quote + reservation from a quote picking the first applicable rate plan and promotions
- [Create a reservation from quote](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_createreservation.md): Create a reservation based on an existing quote with all the necessary reservation data. You can create a quote using the [dedicated endpoint](https://open-api-docs.guesty.com/reference/quotesopenapicontroller_create) or the [booking engine API](https://booking-api-docs.guesty.com/reference/createreservationquote).
- [Decline a channel reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_declinechannelreservation.md): Decline a channel reservation that is in 'reserved' status with a reason and message to the guest. This endpoint creates a decline request that will be processed asynchronously. The reservation must be from a channel (like Airbnb, Booking.com, etc.) and in 'reserved' status to be declined.
- [Delete reservation's Custom Field](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_deletereservationcustomfield.md): Delete an existing custom field from a reservation.
- [Get all custom fields for a reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_getreservationallcustomfields.md): Get all custom fields for a reservation
- [Get a specific custom field for a reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_getreservationcustomfield.md): Get a specific custom field for a reservation by field ID
- [Retrieve Reservations](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_getreservationsbyids.md): Retrieve multiple reservations by ID. Use this endpoint to get all the relevant information about your reservation including the financial breakdown and guest details
- [Pre-approve a channel reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_preapprovechannelreservation.md): Pre-approve a channel reservation that is in 'inquiry' status. This endpoint creates a pre-approval request that will be processed asynchronously. The reservation must be from a channel (like Airbnb) and in 'inquiry' status to be pre-approved. Pre-approval allows guests to complete their booking without requiring additional approval from the host.
- [Create a Reservation Without a Quote](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_quickbooking.md): Create a reservation without needing a quote. When the listing doesn't have an active rate plan assigned, a default rate plan is selected. Otherwise, the first active rate plan is selected.
- [Request cancellation of a channel reservation](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_requestcancellationchannelreservation.md): Request cancellation of a channel reservation with a reason and message to the guest and channel. The reservation must be from a channel and in 'confirmed' status to be cancelled.
- [Search Reservations](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_searchreservations.md): Search reservations with flexible filtering, sorting and pagination. ## Filters Filters use **bracket notation** in the query string: - `filter[]=` — shorthand (defaults to `eq`, or implicit `in` when comma-separated). - `filter[][]=` — explicit operator. Multiple operators on the same field are combined with logical AND, e.g. `filter[checkIn][gte]=2026-01-01&filter[checkIn][lt]=2026-02-01` returns reservations checking in during January 2026. ### Identifier fields (string equality / set membership) | Field | Operators | Notes | |---|---|---| | `status` | `eq`, `ne`, `in`, `nin` | Comma-separated value implies `in` | | `listingId` | `eq`, `in` | Matches `unitId` or `unitTypeId` on the first stay segment | | `confirmationCode` | `eq`, `in` | Comma-separated value implies `in` | | `source` | `eq`, `in` | e.g. `airbnb`, `booking.com`, `manual` | ### Date / range fields (operator required) | Field | Operators | Format | |---|---|---| | `checkIn` | `eq`, `gte`, `gt`, `lte`, `lt` | Localized date `YYYY-MM-DD`, e.g. `2026-01-15` | | `checkOut` | `eq`, `gte`, `gt`, `lte`, `lt` | Localized date `YYYY-MM-DD` | | `createdAt` | `eq`, `gte`, `gt`, `lte`, `lt` | ISO 8601 datetime, e.g. `2026-01-01T00:00:00Z` | ## Sorting Use the `sort` query parameter. Prefix the field with `-` for descending order. Allowed fields: `_id`, `checkIn`, `checkOut`, `createdAt`. Default: `-_id`. ## Pagination Use `skip` (default `0`) and `limit` (default `25`, max `100`). The response includes a `pagination.hasMore` flag.
- [Update Reservation Booking Date](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationbookingdate.md): Update the real-world booking date for a reservation.
- [Update reservation confirmation code](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationconfirmationcode.md): Update the confirmation code of a reservation
- [Update reservation's Custom Fields](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationcustomfields.md): Edit the values of any custom fields on an existing reservation.
- [Update Reservation Dates](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationdates.md): Change the check-in or check-out date and time for a specific reservation. Modifying the date will automatically trigger a financial recalculation, regardless of the `applyRecalculation` flag
- [Update Reservation Guests Breakdown](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationguests.md): Update the reservation guest count, including the guest breakdown object (adults, children, infants, pets, etc.). Financial recalculation is automatically applied
- [Update reservation listing](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationlisting.md): Change a listing for specific reservations.
- [Update Reservation notes](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationnotes.md): Update reservation notes, including the key code and special requests fields
- [Change Reservation Source](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationsource.md): Change a reservation's source and point of sale parameters and choose whether to recalculate financials
- [Update reservation status](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationstatus.md): Update the status of a reservation to one of the supported statuses
- [Update Reservation Travel Information](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationtravelinformation.md): Update travel information for a reservation, including transportation details, reason for visit, and whether it was booked on behalf of someone else
- [Get reservations report by view id](https://open-api-docs.guesty.com/reference/reservationsreportsopenapicontroller_getreportbyviewid.md): Retrieves a report of reservations based on the view ID
- [Delete reservation's custom fields](https://open-api-docs.guesty.com/reference/delete_reservations-reservation-id-custom-fields-field-id.md): For deleting a specific custom field, use the new API
- [Get custom field - Reservations](https://open-api-docs.guesty.com/reference/get_reservations-id-custom-fields-field-id.md): For retrieving a specific custom field, use the new API
- [Retrieve all populated custom fields on an existing reservation.](https://open-api-docs.guesty.com/reference/get_reservations-id-custom-fields.md): For retrieving custom fields, use the new API
- [Retrieve a reservation](https://open-api-docs.guesty.com/reference/get_reservations-id.md): This allows you to obtain details about a specific reservation. NOTE: - To include the check-in and check-out times of a reservations include the parameters: `listing.defaultCheckInTime`, `plannedArrival`, `listing.defaultCheckOutTime` and `plannedDeparture`. Planned arrival and departure times override the default times. - Use `checkInDateLocalized` and `checkOutDateLocalized` to retrieve the reservation according to the location of the listing.
- [Search reservations](https://open-api-docs.guesty.com/reference/get_reservations.md): Retrieve all reservations or a filtered subset of them.
- [Cancels a pending or recorded payment](https://open-api-docs.guesty.com/reference/patch_reservations-id-payments-paymentid-cancel.md): Use this endpoint to cancel a pending or recorded payment
- [Export as CSV](https://open-api-docs.guesty.com/reference/post_reservations-csv.md): Use this request to export a custom list of reservations as CSV file. Results are limited to 500 reservations per a request.
- [Send results in email](https://open-api-docs.guesty.com/reference/post_reservations-email.md): Use this request to export a custom list of reservations in an Email. Results are limited to 250 reservations per a request.
- [Approve a pending booking request](https://open-api-docs.guesty.com/reference/post_reservations-id-approve.md): Use this call to accept a pending reservation request. Only reservation with status 'reserved' can be approved
- [Decline a pending booking request](https://open-api-docs.guesty.com/reference/post_reservations-id-decline.md): Use this call to deny a pending reservation request. Only reservation with status 'reserved' can be declined
- [Create new Invoice item](https://open-api-docs.guesty.com/reference/post_reservations-id-invoiceitems.md): For creating new invoice item use the new API
- [Refund an existing payment](https://open-api-docs.guesty.com/reference/post_reservations-id-payments-paymentid-refund.md): Use this endpoint to refund a guest's payment charged on an existing reservation.
- [Add a payment to reservation](https://open-api-docs.guesty.com/reference/post_reservations-id-payments.md): Use this request to create an immediate or future payment, and to add a record to payment history. An immediate or future payment is charged using a credit card, where a rerocded payment indicates the funds were collected in other methods such as bank transfer, cash, e-check etc
- [Request airbnb reservation cancellation on the platform](https://open-api-docs.guesty.com/reference/post_reservations-id-request-cancellation-sync.md): Use this call to request a new reservation cancellation from your guest.
- [Create a reservation](https://open-api-docs.guesty.com/reference/post_reservations.md): Use this request to create a direct booking. **Note:** This endpoint is soon to be deprecated. Please use [this endpoint](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_quickbooking) instead.
- [Update reservation's Custom Fields](https://open-api-docs.guesty.com/reference/put_reservations-id-custom-fields.md): For updating custom fields, use the new API
- [Update or cancel a payment for reservation](https://open-api-docs.guesty.com/reference/put_reservations-id-payments-paymentid.md): Use this request to update or cancel an upcoming payment. To cancel, set the the payment status to `CANCELLED`.
- [Update a reservation](https://open-api-docs.guesty.com/reference/put_reservations-id.md): Use this request to alter a guest reservation. NOTE: - To amend the check-in and check-out dates, please use`checkInDateLocalized` and `checkOutDateLocalized` with the format `YYYY-MM-DD`. In this case, we do not recommend using fields `checkIn` and `checkOut` with UTC format (example `2023-01-30T10:00:00+02:00`) it might cause timezone and dates discrepancies. - Update check-in and check-out times using `plannedArrival` and `plannedDeparture`. IMPORTANT: Include `ignoreCalendar` and `ignoreTerms` at your own risk. These will ignore any calendar block or listing requirement and may lead to an overbooking or unsuitable booking.
- [Create a custom channel](https://open-api-docs.guesty.com/reference/reviewcontroller_createcustomchannel.md): Create a custom channel for an account
- [Publish a custom-channel review](https://open-api-docs.guesty.com/reference/reviewcontroller_createcustomchannelreview.md): Publish a custom-channel review
- [Retrieve Average reviews score by Listings IDs](https://open-api-docs.guesty.com/reference/reviewcontroller_getlistingsaveragereview.md): Retrieve Average reviews score by Listings IDs
- [Retrieve a review](https://open-api-docs.guesty.com/reference/reviewcontroller_getreview.md): Retrieve a review
- [Retrieve reviews sorted descending by last update time](https://open-api-docs.guesty.com/reference/reviewcontroller_getreviews.md): Retrieve reviews sorted descending by last update time
- [List custom channel names](https://open-api-docs.guesty.com/reference/reviewcontroller_listcustomchannelnames.md): Retrieve a list of custom channel names for the account
- [Publish review reply to channel](https://open-api-docs.guesty.com/reference/reviewcontroller_upsertreviewreply.md): Publish reply to channel and store in DB. Airbnb and Booking.com allow to publish only one reply per review. Airbnb allows to update reply. Booking.com does not allow to update reply
- [Assign roles](https://open-api-docs.guesty.com/reference/openapirolecontroller_assignrolestouser.md): Assigns the specified roles to a user. This will replace any existing role assignments for the user.
- [Get available roles](https://open-api-docs.guesty.com/reference/openapirolecontroller_getaccountroles.md): Returns the list of all roles available for assignment within the account.
- [Get assigned roles](https://open-api-docs.guesty.com/reference/openapirolecontroller_getuserroles.md): Returns the list of roles currently assigned to the specified user.
- [Retrieve a Room Photo by ID](https://open-api-docs.guesty.com/reference/get1.md): Get a room photo mapping for a photo, including photo id, space id and photo URL
- [List All Room Photos per Property](https://open-api-docs.guesty.com/reference/getroomphotosbypropertyid.md): Retrieve a list of all room photo mappings for each property, including photo ID, space ID, and photo URL.
- [Assign a Photo to a Space](https://open-api-docs.guesty.com/reference/roomphotoscontroller_assignroomphoto.md): Assigns the selected photo to a space.
- [Unassign a Photo from a Space](https://open-api-docs.guesty.com/reference/roomphotoscontroller_unassignroomphoto.md): Removes the selected photo from the designated space.
- [Delete saved reply by id](https://open-api-docs.guesty.com/reference/delete_saved-replies-replyid.md)
- [Get saved replies by listing id](https://open-api-docs.guesty.com/reference/get_saved-replies-listing-listingid.md): Returns saved replies filtered by the listing id. By default only ids are returned.
- [Get saved reply by id](https://open-api-docs.guesty.com/reference/get_saved-replies-replyid.md)
- [Get saved replies](https://open-api-docs.guesty.com/reference/get_saved-replies.md)
- [Post saved reply](https://open-api-docs.guesty.com/reference/post_saved-replies.md)
- [Update saved reply by id](https://open-api-docs.guesty.com/reference/put_saved-replies-replyid.md)
- [List bed-types](https://open-api-docs.guesty.com/reference/get_properties-spaces-bed-types.md)
- [Retrieve spaces for a complex](https://open-api-docs.guesty.com/reference/get_properties-spaces-complex-complexid.md)
- [List room-types](https://open-api-docs.guesty.com/reference/get_properties-spaces-room-types.md)
- [Retrieve spaces for a unit-type](https://open-api-docs.guesty.com/reference/get_properties-spaces-unit-type-unittypeid.md)
- [Edit space details](https://open-api-docs.guesty.com/reference/patch_properties-spaces-space-spaceid-details.md)
- [Edit space beds](https://open-api-docs.guesty.com/reference/post_properties-spaces-space-spaceid-edit.md)
- [Remove space from unit-type](https://open-api-docs.guesty.com/reference/post_properties-spaces-space-spaceid-remove.md)
- [Add space to unit-type (Create Space)](https://open-api-docs.guesty.com/reference/post_properties-spaces-unit-type-unittypeid-add.md)
- [Delete a task](https://open-api-docs.guesty.com/reference/delete_tasks-open-api-taskid.md)
- [Get a specific task](https://open-api-docs.guesty.com/reference/get_tasks-open-api-taskid.md)
- [Get tasks list](https://open-api-docs.guesty.com/reference/get_tasks-open-api-tasks.md)
- [Create a new task](https://open-api-docs.guesty.com/reference/post_tasks-open-api-create-single-task.md)
- [Update a task](https://open-api-docs.guesty.com/reference/put_tasks-open-api-taskid.md)
- [Create tax](https://open-api-docs.guesty.com/reference/openapitaxescontroller_createtax.md): Create tax configuration with the provided settings.
- [Delete tax](https://open-api-docs.guesty.com/reference/openapitaxescontroller_deletetax.md): Delete tax by id.
- [Get account level taxes](https://open-api-docs.guesty.com/reference/openapitaxescontroller_getaccountleveltaxes.md): Get account level taxes
- [Get actual taxes of unit type (parent unit level)](https://open-api-docs.guesty.com/reference/openapitaxescontroller_getunittypeactualtaxes.md): Get actual taxes of unit type (parent unit level)
- [Get unit type (parent unit) level taxes](https://open-api-docs.guesty.com/reference/openapitaxescontroller_getunittypeleveltaxes.md): Get unit type (parent unit) level taxes
- [Update tax](https://open-api-docs.guesty.com/reference/openapitaxescontroller_updatetax.md): Update tax by id.
- [Get tax level configuration](https://open-api-docs.guesty.com/reference/taxeslevelconfigurationscontroller_getunittypetaxeslevelconfigurations.md): Get tax level configuration
- [Create or update tax level configuration](https://open-api-docs.guesty.com/reference/taxeslevelconfigurationscontroller_upserttaxeslevelconfigurationsopenapi.md): Use to define on which level the taxes are defined for a specific unit type.
- [Assign scope](https://open-api-docs.guesty.com/reference/openapiuserscopecontroller_assignscope.md): Assigns a scope of permitted properties to a user. Replaces any existing scope. Use `assignAll: true` to grant access to all properties, or provide specific `listingIds`.
- [Get scope](https://open-api-docs.guesty.com/reference/openapiuserscopecontroller_getscope.md): Returns the current scope of permitted properties assigned to the specified user.
- [Create user](https://open-api-docs.guesty.com/reference/createuser.md): Create a new user. After creation, please use "Assign roles" endpoint to grant roles to the user, and "Assign scope" endpoint to assign a scope of permitted properties.
- [Get user](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_getuserbyid.md): Get a user by ID.
- [List all users](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_getusers.md): List all users
- [Delete user](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_removeuser.md): Delete user by ID
- [Update user](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_updateuser.md): Update user by ID
- [Create vendor](https://open-api-docs.guesty.com/reference/vendorscontroller_create.md): Create a new vendor
- [Query vendors](https://open-api-docs.guesty.com/reference/vendorscontroller_getall.md): Get a list of vendors
- [Query a vendor](https://open-api-docs.guesty.com/reference/vendorscontroller_getbyid.md): Get specific vendor by ID
- [Update a vendor](https://open-api-docs.guesty.com/reference/vendorscontroller_patch.md): Update a vendor
- [Delete a view](https://open-api-docs.guesty.com/reference/delete_views-id.md)
- [Retrieve a view](https://open-api-docs.guesty.com/reference/get_views-id.md)
- [Retrieve all views](https://open-api-docs.guesty.com/reference/get_views.md)
- [Create a view](https://open-api-docs.guesty.com/reference/post_views.md)
- [Update a view](https://open-api-docs.guesty.com/reference/put_views-id.md)
- [Delete webhook](https://open-api-docs.guesty.com/reference/delete_webhooks-id.md)
- [Retrieve a Webhook](https://open-api-docs.guesty.com/reference/get_webhooks-id.md)
- [List all webhooks](https://open-api-docs.guesty.com/reference/get_webhooks.md): List all webhooks
- [Create a Webhook](https://open-api-docs.guesty.com/reference/post_webhooks.md)
- [Update webhook](https://open-api-docs.guesty.com/reference/put_webhooks-id.md): Update a webhook
- [Get webhook secret](https://open-api-docs.guesty.com/reference/svixsecretapicontroller_getsecret.md): Get the secret for a webhook endpoint
## Recipes
- [Access token management](https://open-api-docs.guesty.com/recipes/access-token-management.md)
## Changelog
- [2026-06-03](https://open-api-docs.guesty.com/changelog/2026-06-03.md)
- [2026-05-26](https://open-api-docs.guesty.com/changelog/2026-05-26.md)
- [2026-05-21](https://open-api-docs.guesty.com/changelog/2026-05-21.md)
- [2026-05-12](https://open-api-docs.guesty.com/changelog/2026-05-12.md)
- [2026-05-11](https://open-api-docs.guesty.com/changelog/2026-05-11.md)