# Guesty Open API Documentation > Guesty's official Open API developer portal. It contains the complete reference documentation, supplemented by guides and a changelog. ## Guides: Overviews - [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… - [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. - [Authentication](https://open-api-docs.guesty.com/docs/authentication.md): Generating an access token to authenticate Open API requests. - [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. - [Rate Limits](https://open-api-docs.guesty.com/docs/rate-limits.md): Guesty's Open API rate limits and how to work with them. ## Guides: Migrations and Deprecations - [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. - [Optimized Calendar Webhook and Endpoint](https://open-api-docs.guesty.com/docs/calendar-webhook-migration.md): Introducing a new lightweight calendar webhook. - [Reservation webhooks migration](https://open-api-docs.guesty.com/docs/reservation-webhooks-migration-guide.md): How to move from legacy reservation events to v2 ones ## Guides: Best Practices - [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. - [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. ## Guides: Accounting - [Vendors](https://open-api-docs.guesty.com/docs/vendors.md): How to retrieve vendor information. ## Guides: AI - [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 ## Guides: Calendar - [Calendar Block Types](https://open-api-docs.guesty.com/docs/calendar-block-types.md): How to read and understand calendar blocks. ## Guides: Guests - [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. ## Guides: Guest Payments - [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. - [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. - [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. - [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. - [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. - [Refunding a Guest Payment](https://open-api-docs.guesty.com/docs/refunding-a-guest-payment.md): How to refund a guest payment. - [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. - [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. - [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. - [Virtual credit card (VCC) payments](https://open-api-docs.guesty.com/docs/virtual-credit-card-vcc-payments.md): How to identify and work with virtual credit cards in Guesty. ## Guides: Manage Communications - [Retrieve Message Attachments](https://open-api-docs.guesty.com/docs/retrieve-message-attachments.md): How to identify and retrieve message attachments. ## Guides: Property Management - [Create a Property](https://open-api-docs.guesty.com/docs/create-a-property.md): How to create a listing in Guesty. - [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 Descriptions](https://open-api-docs.guesty.com/docs/listing-descriptions.md): How to edit a property's marketing descriptions. - [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. - [Rooms, Beds, and Bathrooms](https://open-api-docs.guesty.com/docs/bedrooms-beds.md): Configure the rooms, beds, and bathrooms at your property. - [Property Financials](https://open-api-docs.guesty.com/docs/listing-financials.md): An explanation of a property's default financials. - [Booking Settings](https://open-api-docs.guesty.com/docs/booking-settings.md): Define a property's booking window and default availability. - [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. - [Deactivate and Activate a Property](https://open-api-docs.guesty.com/docs/deactivating-listings.md): How to deactivate and activate a property in Guesty. - [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. ## Guides: Reservations Management - [Booking Flow](https://open-api-docs.guesty.com/docs/booking-flow.md): Guide to booking workflows with the Open API. - [Query Available Listings](https://open-api-docs.guesty.com/docs/available-listings.md): Retrieving available listings via 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. - [Create a Reservation](https://open-api-docs.guesty.com/docs/create-a-reservation.md): How to create a reservation using the OAPI - [Reservation Alterations](https://open-api-docs.guesty.com/docs/reservation-alterations.md): Common alterations performed on current and future reservations. - [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. - [Relocating a Guest](https://open-api-docs.guesty.com/docs/relocating-a-guest.md): Moving a reservation to another listing. - [Canceling a Booking or Inquiry](https://open-api-docs.guesty.com/docs/canceling-a-booking-or-inquiry.md): Understand the different reservation cancellation flows. - [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 - [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 ## Guides: Webhooks - [Subscribe to webhooks](https://open-api-docs.guesty.com/docs/webhooks.md): Subscribe to and handle Guesty webhook events. - [Calendar webhooks](https://open-api-docs.guesty.com/docs/webhooks-calendar.md): Webhook notifications for calendar activity. - [Communication webhooks](https://open-api-docs.guesty.com/docs/webhooks-messages.md): Webhook notifications for new messages in the Guest Inbox. - [Financial webhooks](https://open-api-docs.guesty.com/docs/financial-webhooks.md): Subscribe to and troubleshoot financial webhook events - [Guest webhooks](https://open-api-docs.guesty.com/docs/webhooks-guests.md): Webhook notifications for the creation, alteration and deletion of guest objects. - [Property webhooks](https://open-api-docs.guesty.com/docs/webhooks-listings.md): Webhook notifications for changes to listings. - [Payment webhooks](https://open-api-docs.guesty.com/docs/webhooks-payments.md): Subscribe to payment events to get notified of reservation payment activity. - [Reservation webhooks](https://open-api-docs.guesty.com/docs/webhooks-reservations.md): Subscribe to and troubleshoot reservation webhook events. - [Tasks Webhooks](https://open-api-docs.guesty.com/docs/webhooks-tasks.md): Webhook notifications for task-related actions. ## Guides: Reference - [Valid Enumerations](https://open-api-docs.guesty.com/docs/valid-enumerations.md): Tables of valid values for enumerations. - [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. - [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. ## API Reference: Getting Started - [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. - [Authentication](https://open-api-docs.guesty.com/reference/authentication-2.md): How to authenticate your API requests. - [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. ## API Reference: GUESTY OPEN API - Account Brands - [Get brand by property_id.](https://open-api-docs.guesty.com/reference/externalintegrationscontroller_getbrandbyproperty.md): Http endpoint to retrieve brandings by property id. - Accounting (only available for accounting add-on users) - [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. - [Get recognized journal entries](https://open-api-docs.guesty.com/reference/journalentriescontroller_getrecognized.md): Retrieves recognized journal entries matching the specified parameters - [Get all journal entries](https://open-api-docs.guesty.com/reference/journalentriescontroller_getall.md): Retrieves all 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 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. - [List disbursements](https://open-api-docs.guesty.com/reference/disbursementscontroller_getdisbursements.md): Returns account-scoped disbursements with filtering, sorting, and offset pagination. Mirrors the Disbursements report columns. Monetary amount / line-item breakdown is intentionally out of scope for… - [Get a disbursement by ID](https://open-api-docs.guesty.com/reference/disbursementscontroller_getdisbursementbyid.md): Returns an account-scoped disbursement. A missing disbursement and a disbursement owned by another account both return 404. Mirrors the Disbursements report columns. Monetary amount / line-item… - [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, pass includeAssignedListings=true to include per-model assignedListings - [Partial Update Business Model](https://open-api-docs.guesty.com/reference/businessmodelsoacontroller_partialupdate.md): Updates only whitelisted fields without requiring full Business Model payload. Creates new version with updated fields. Currently supports: category. - [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 a PMC expense (PMC pays the vendor). By default, 100% of the expense is applied to the PMC. If you provide expenseShare, the expense is split between PMC and a specific owner (the owner share… - [Create expense by listing](https://open-api-docs.guesty.com/reference/transactionscontroller_createexpensebylisting.md): Create a PMC expense for the provided listing (PMC pays the vendor). By default, 100% of the expense is applied to the PMC. If you provide expenseShare, the expense is split between PMC and Owner:… - Accounts - [Get account details](https://open-api-docs.guesty.com/reference/accountsget.md): Retrieve the account details associated with the token making the request, including its settings and custom field values. The fields returned depend on the caller's permissions — restricted areas of… - [List custom field configurations](https://open-api-docs.guesty.com/reference/accountscustomfieldlist.md): Retrieve every custom field defined on the account, across all object types. Each field is returned with its `fieldId`, along with the `key`, `displayName`, `object` and `type` it was created with. - [Create custom field configurations](https://open-api-docs.guesty.com/reference/accountscustomfieldcreate.md): Add one or more custom fields to the account in a single request. Each field requires `key`, `object` and `type`; `displayName` is generated from the `key`, lowercased with spaces replaced by… - [Update custom field configurations](https://open-api-docs.guesty.com/reference/accountscustomfieldupdate.md): Replace the account's custom field definitions. The `customFields` array you send replaces the entire existing set, so any field you omit is removed from the account. Every field must carry a… - [Get a custom field configuration](https://open-api-docs.guesty.com/reference/accountscustomfieldget.md): Retrieve a single custom field definition by its ID. The `field_id` is the `fieldId` value returned when listing or creating custom fields. - [Delete a custom field configuration](https://open-api-docs.guesty.com/reference/accountscustomfielddelete.md): Remove a custom field definition from the account. Returns the account's remaining custom fields. - AdditionalFees - [Create additional fee on account level](https://open-api-docs.guesty.com/reference/post_additional-fees-account.md) - [Get list of additional fees for account](https://open-api-docs.guesty.com/reference/get_additional-fees-account.md) - [Create additional fee on listing level](https://open-api-docs.guesty.com/reference/post_additional-fees-listing-listingid.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) - [Delete existing additional fee](https://open-api-docs.guesty.com/reference/delete_additional-fees-id.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] - [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] - Address - [Retrieve Property Address](https://open-api-docs.guesty.com/reference/addresscontroller_getaddress.md): Get the listing address of the given property. - [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. - [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. - Airbnb Listing Expectations - [Upsert Airbnb listing expectations](https://open-api-docs.guesty.com/reference/listingexpectationscontroller_upsertlistingexpectations.md): Upsert listing expectations for Airbnb channel by Guesty listing ID. - [Retrieve Airbnb listing expectations](https://open-api-docs.guesty.com/reference/listingexpectationscontroller_getlistingexpectations.md): Get listing expectations for Airbnb channel by Guesty listing ID. - Airbnb Resolution Center - [List closed airbnb resolutions for reservation](https://open-api-docs.guesty.com/reference/airbnbresolutionscontroller_listresolutions.md): List closed airbnb resolutions for reservation. - Amenities - [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 a List Of All Available Amenity Groups](https://open-api-docs.guesty.com/reference/getamenitiesgroups.md): Get a list of all available amenity groups - [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 - [Beta] Basic Fees - [List basic fees for listings](https://open-api-docs.guesty.com/reference/openapibasicfeescontroller_getmany.md): Returns basic fee configuration (cleaning fee) for the given listing IDs. Listing IDs with no basic fees configured are omitted from the 200 array (not 404). Pass listing IDs as repeated query… - [Get listing basic fees](https://open-api-docs.guesty.com/reference/openapibasicfeescontroller_get.md): Returns basic fee configuration (cleaning fee) for a single listing. - [Update listing basic fees](https://open-api-docs.guesty.com/reference/openapibasicfeescontroller_upsert.md): Upsert replaces stored listing-default `cleaningFee` only when `cleaningFee` is sent; omitting it keeps the stored default. This PUT cannot clear only the listing default while keeping overrides —… - [Delete listing basic fees](https://open-api-docs.guesty.com/reference/openapibasicfeescontroller_delete.md): Deletes basic fee configuration (cleaning fee) for a listing. - [Get listing cleaning fee for channel](https://open-api-docs.guesty.com/reference/openapibasicfeescontroller_getbychannel.md): Returns the effective cleaning fee for that channel (channel override if present, else listing default). When basic fees are configured for the listing but have neither a listing default nor a… - Calendar - [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… - [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. - [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):… - [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 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,… - Calendar Logs - [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. - Calendar Sync (iCal export) - [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… - [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… - [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… - [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. - Calendar Sync (iCal import) - [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 - [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… - [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 calendars list](https://open-api-docs.guesty.com/reference/importedcalendaropenapicontroller_getimportedcalendars.md): To retrieve a list of all imported calendars, use the following request. - [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… - [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. - Channel Commission - [Update account channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_updateaccountchannelcommission.md): This endpoint is deprecated — do not use it. Migrate to [PUT /channel-commissions-v2/account](/reference/channelcommissionsopenapicontroller_updatechannelcommissionaccountlevel). No removal date has… - [Get account channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_getaccountchannelcommission.md): This endpoint is deprecated — do not use it. Migrate to [GET /channel-commissions-v2/account](/reference/channelcommissionsopenapicontroller_getaccountlevelchannelcommissions). No removal date has… - [Update listings channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_updatelistingschannelcommission.md): This endpoint is deprecated — do not use it. Migrate to [PUT /channel-commissions-v2/unit-type/{unitTypeId}](/reference/channelcommissionsopenapicontroller_updatechannelcommission) and [PUT… - [Get listings channel commission](https://open-api-docs.guesty.com/reference/channelcommissioncontroller_getlistingschannelcommission.md): This endpoint is deprecated — do not use it. Migrate to [GET /channel-commissions-v2/unit-type/{unitTypeId}](/reference/channelcommissionsopenapicontroller_getlistinglevelchannelcommissions) (stored… - [Create channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_create.md): Creates a single channel commission for a channel and source. Omit `unitTypeId` for an account-level commission. Provide `unitTypeId` for a listing-level commission. Listing-level commissions are… - [Update channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_update.md): Updates an existing channel commission identified by `channelCommissionId` (the `_id` from a GET response). Omit `unitTypeId` for an account-level commission. Provide `unitTypeId` for a… - [Delete channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_delete.md): Deletes a channel commission by its `channelCommissionId` — the `_id` of an item from GET `/account`, GET `/unit-type/{unitTypeId}`, or GET `/unit-type/{unitTypeId}/actual`. If it is the last… - [Get account level channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_getaccountlevelchannelcommissions.md): Returns all account-level channel commission entries for the authenticated account. Each item includes commission percentage, tax, channel/source, and `levelEntityType` set to `ACCOUNT`. Returns an… - [Update or create account level channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_updatechannelcommissionaccountlevel.md): Replaces all account-level channel commissions for the authenticated account. Send an array of channel and source commission definitions. Each item requires `channel` and `source`; `tax` and… - [Get listing level channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_getlistinglevelchannelcommissions.md): Returns channel commission entries stored specifically for the given listing (unit type). This does not resolve account-level inheritance — it returns only listing-level stored values. Each item… - [Update or create listing level channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_updatechannelcommission.md): Replaces all listing-level channel commissions for the given listing. Send an array of channel and source commission definitions. Each item requires `channel` and `source`; `tax` and `commission`… - [Get effective listing channel commissions](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_getlistingactualchannelcommissions.md): Returns the channel commissions that currently apply to the listing, after resolving the listing level configuration. If the listing is configured to use account settings (`levelEntityType` =… - [Get listing commission level configuration](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_getlevelconfiguration.md): Returns whether the listing uses account-level or listing-level channel commissions. `levelEntityType` is `ACCOUNT` when reservations on this listing should take commissions from account settings,… - [Update listing commission level configuration](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_updatelistinglevelconfiguration.md): Sets whether channel commissions for reservations on this listing are taken from account-level or listing-level settings. Send `levelEntityType`: `ACCOUNT` to inherit account commissions, or… - [[Beta] Update reservation channel commission](https://open-api-docs.guesty.com/reference/channelcommissionsopenapicontroller_updatereservationchannelcommission.md): [Beta] Sets a custom channel commission amount on a reservation and updates the folio. Send the new `amount` in the reservation currency and `realizationDates` for when it should be recognized.… - Complexes - [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 - [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 - [Get complex](https://open-api-docs.guesty.com/reference/complexescontroller_getcomplexbyid.md): Get a specific complex based on the complexId - [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 - [Delete complex](https://open-api-docs.guesty.com/reference/complexescontroller_removecomplex.md): Deletes a specific complex based on the complexId - [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 - [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 - Custom Fields - [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. - [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 - [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. - [Delete Custom Field from property](https://open-api-docs.guesty.com/reference/delete.md): Delete a specific custom field value from property - Expenses (only available for accounting add-on users) - [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.… - [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,… - [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. - [Cancel expense](https://open-api-docs.guesty.com/reference/expensescontroller_cancelexpense.md): 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… - [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… - [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. - Groups [Pilot] - [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… - [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).… - [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… - [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… - [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… - Group Reservations Open Api [Beta] - [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 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 - Guest app - [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. - Guest Folio - [Get guest folio overview](https://open-api-docs.guesty.com/reference/guestfoliocontroller_getfoliooverview.md): Retrieves a financial overview for one or more reservations from the guest folio. **Field selection** You must specify at least one field to return via the `fields` query parameter. `reservationId`… - [Get invoice items](https://open-api-docs.guesty.com/reference/getguestfolioinvoiceitems.md): Retrieves invoice items for one or more reservations. **Field selection** You must specify at least one field to return via the `fields` query parameter. `id` is always included on every invoice… - [Get settings snapshots](https://open-api-docs.guesty.com/reference/getguestfoliosettingssnapshots.md): View the tax, fee, commission, and currency conversion settings that were used to calculate each reservation's financials for every stay. These settings reflect what was applied **at the time of… - Guests - [Create guest](https://open-api-docs.guesty.com/reference/guestsopenapicontroller_createguest.md): Create guest - [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 - [Get guest by id](https://open-api-docs.guesty.com/reference/guestsopenapicontroller_getguest.md): Get guest by id - [Add a payment method for a guest](https://open-api-docs.guesty.com/reference/guestspaymentmethodcreate.md): Attach a payment method to a guest. Card details are never sent to this endpoint — tokenize the card first, then pass the resulting token: `stripeCardToken` when the payment provider is Stripe, or… - [List a guest's payment methods](https://open-api-docs.guesty.com/reference/guestspaymentmethodlist.md): Retrieve payment method list by guest id - Guesty Locks Manager - [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… - House Rules - [Retrieve unit-type house-rules](https://open-api-docs.guesty.com/reference/get_properties-house-rules-unit-type-unittypeid.md) - [Update unit-type house-rules](https://open-api-docs.guesty.com/reference/put_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) - Inbox Conversations - [Get conversations](https://open-api-docs.guesty.com/reference/get_communication-conversations.md): Get conversations - [Get conversation by id](https://open-api-docs.guesty.com/reference/get_communication-conversations-conversationid.md) - [Get posts (by conversation id)](https://open-api-docs.guesty.com/reference/get_communication-conversations-conversationid-posts.md) - [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. - Integrations - [List integrations](https://open-api-docs.guesty.com/reference/accountsintegrationlist.md): Retrieve a list of all your account integrations. - [Create an integration](https://open-api-docs.guesty.com/reference/accountsintegrationcreate.md): Deprecated: Was used for building an integration between Guesty and a third-party. - [Get an integration](https://open-api-docs.guesty.com/reference/accountsintegrationget.md): Retrieve a single account integration. - [Update an integration](https://open-api-docs.guesty.com/reference/accountsintegrationupdate.md): Selectively update fields of single account integration. - Invoice Items - [Create invoice item](https://open-api-docs.guesty.com/reference/invoiceitemscontroller_createinvoiceitem.md): Adds an invoice item to the reservation's folio and returns the updated folio. Use this when you need to add a one-off charge (for example an additional fee, cleaning fee, or tax) to an existing… - Listings - [List listings](https://open-api-docs.guesty.com/reference/propertieslistinglist.md): Retrieve the listings on your account as a paginated result set carrying `results`, `fields` and `limit`. Combine the filter parameters to narrow the set, or pass `viewId` to apply the filters,… - [Create a listing](https://open-api-docs.guesty.com/reference/propertieslistingcreate.md): Create a listing on your account. The address you supply is geocoded to resolve its coordinates. A new listing is unlisted until you publish it, and check-in and check-out default to 15:00 and 11:00… - [Get a listing](https://open-api-docs.guesty.com/reference/propertieslistingget.md): Retrieve a single listing by its ID. By default the full listing is returned; pass `fields` to select only the properties you need. - [Update a listing](https://open-api-docs.guesty.com/reference/propertieslistingupdate.md): Apply a partial update to a listing. Only the fields you send are changed, except arrays, which are replaced wholesale rather than merged. The response echoes back only the fields you sent, together… - [Delete a listing](https://open-api-docs.guesty.com/reference/propertieslistingdelete.md): Permanently delete a listing. A listing that is still connected to a channel cannot be deleted — disconnect it from all its integrations first. Detach the listing from any complex or multi-unit… - [Update listing availability settings](https://open-api-docs.guesty.com/reference/propertiesavailabilitysettingupdate.md): Update how a listing's calendar behaves: whether dates are open or blocked by default, the minimum nights required at different times of year, and how much preparation time to leave between… - [List cities](https://open-api-docs.guesty.com/reference/propertiescitylist.md): List the cities your listings are located in. Returns a flat array of unique city names sorted alphabetically, so you can build a city filter without pulling every listing. - [List listing tags](https://open-api-docs.guesty.com/reference/propertiestaglist.md): List the tags used across your listings. Returns a flat array of unique tag names sorted alphabetically, so you can build a tag filter without pulling every listing. - [Get a listing's payment provider](https://open-api-docs.guesty.com/reference/propertiespaymentprovideridget.md): Important! This is required to reconcile with the Stripe account to clear the payment - [Download a listings report as a CSV](https://open-api-docs.guesty.com/reference/propertiesexportlistingscsvdownload.md): Same as GET /listings but results are returned as a downloadable csv file - [Email a listings report](https://open-api-docs.guesty.com/reference/propertieslistingemailsend.md): Same as /listings but results are sent as an email - [List a listing's custom fields](https://open-api-docs.guesty.com/reference/propertieslistingcustomfieldlist.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/getall - [Update a listing's Custom Fields](https://open-api-docs.guesty.com/reference/propertieslistingcustomfieldupdate.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/updatemany - [Get listing custom field](https://open-api-docs.guesty.com/reference/propertieslistingcustomfieldget.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/getbyfieldid - [Delete a listing's custom fields](https://open-api-docs.guesty.com/reference/propertieslistingcustomfielddelete.md): Soon to be deprecated. Please migrate to: https://open-api-docs.guesty.com/reference/delete - [Get a listing's financial settings](https://open-api-docs.guesty.com/reference/propertiesfinancialsget.md): Retrieve a listing's pricing and fee setup, covering its base price, extra-person and cleaning fees, security deposit and channel commission. Where a connected channel overrides one of these values,… - [Update a listing's financial settings](https://open-api-docs.guesty.com/reference/propertiesfinancialsupdate.md): Only accessible to Admin or User tokens. - Listing external links - [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… - [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… - [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… - [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 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. - Marketing fields - [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. - [Upsert translation](https://open-api-docs.guesty.com/reference/upsertfields.md): Upsert a new translation for specific listing and language slug. - [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] upsert supported languages for specific listing](https://open-api-docs.guesty.com/reference/upsertpropertylanguages.md): Upsert supported languages for specific listing - [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. - [[Beta] Create Description Set.](https://open-api-docs.guesty.com/reference/createdescriptionset.md): Create a new Description Set. - [[Beta] Update Description Set.](https://open-api-docs.guesty.com/reference/updatedescriptionset.md): Update the Description Set. - [[Beta] Delete Description Set.](https://open-api-docs.guesty.com/reference/deletedescriptionset.md): Delete the Description Set. - Open Api Ari Calendar v1 - [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. - Open Api Rate Plan CRUD v1 - [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… - [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… - [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.… - [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… - [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… - [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… - [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… - [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… - [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.… - Owners - [Create multiple owners with assigned listings](https://open-api-docs.guesty.com/reference/ownersbulkopenapicontroller_createbulk.md): Create multiple owners with assigned listings - [Get list of owners](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_getall.md): Get list of owners - [Create an owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_create.md): Create an owner - [Get owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_get.md): Get owner - [Update owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_update.md): Update owner (supports partial update) - [Delete owner](https://open-api-docs.guesty.com/reference/ownersopenapicontroller_delete.md): Delete 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 - Owners Documents - [Get list of documents](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_getall.md): Get list of documents - [Create a document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_create.md): Create a document - [Get document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_get.md): Get document - [Update document](https://open-api-docs.guesty.com/reference/documentsopenapicontroller_update.md): Update document (supports partial update) - [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 - Owners Reservations - [List owner reservations](https://open-api-docs.guesty.com/reference/ownerreservationslist.md): Retrieve a list of all owner reservations. This endpoint is filterable. **Note:** This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the [Reservations… - [Get an owner reservation](https://open-api-docs.guesty.com/reference/ownerreservationsget.md): This allows you to obtain details about a specific owner's reservation. **Note:** This endpoint is soon to be deprecated. Please use [this… - [Update an owner reservation](https://open-api-docs.guesty.com/reference/ownerreservationsupdate.md): Use this request to alter an owner's reservation. **Note:** This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the [Reservations V3 Booking Flow… - Ownerships - [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 - Owner Statements (only available for accounting add-on users) - [List owner statements](https://open-api-docs.guesty.com/reference/ownerstatementscontroller_list.md): Returns owner statement metadata with table-parity fields (listings, business models, status, sharing channels, generation date, minimum account balance) and presigned PDF download URLs (valid for 1… - Payment Methods - [List payment methods](https://open-api-docs.guesty.com/reference/paymentspaymentmethodlist.md): Lists payment methods for a guest or a reservation. Provide exactly one of `guestId` or `reservationId`. Replaces the deprecated [List a guest's payment… - [Create payment method](https://open-api-docs.guesty.com/reference/paymentspaymentmethodcreate.md): Vaults a payment method for a guest. Card details are not sent here. Send exactly one of `_id` or `stripeCardToken`. Replaces the deprecated [Add a payment method for a… - [Get payment method](https://open-api-docs.guesty.com/reference/paymentspaymentmethodget.md): Returns a payment method by ID. - Payment providers - [Assign listings to Stripe account](https://open-api-docs.guesty.com/reference/paymentprovidersstripeassign.md): Assign listings to a Stripe payment processing account, so that payments collected for those listings are processed through it. - [Get summary ](https://open-api-docs.guesty.com/reference/getsummary.md) - [Get default payment provider](https://open-api-docs.guesty.com/reference/getdefaultprovider.md) - [Get provider stats](https://open-api-docs.guesty.com/reference/getstats.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) - Payment Transactions - [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… - [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 -… - Payouts - [Get owner payout method](https://open-api-docs.guesty.com/reference/openapicontroller_getownerpayoutmethods.md): Returns the payout method configured for the given owner. - [Create owner payout method](https://open-api-docs.guesty.com/reference/openapicontroller_createownerpayoutmethod.md): Creates a payout method 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. - [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. - Phone Book Entries - [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. - [Update a contact](https://open-api-docs.guesty.com/reference/openapicontactscontroller_update.md): Updates an existing contact with the provided information. - [Delete a contact](https://open-api-docs.guesty.com/reference/openapicontactscontroller_remove.md): Permanently deletes a contact from the phonebook. - Pre-approve inquiry - [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). - Price Adjustments - [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 - [Get adjustable line items for a reservation](https://open-api-docs.guesty.com/reference/priceadjustmentscontroller_getadjustablelineitems.md): Returns adjustable base and tax line items for the FE dropdown (TPLI / inclusive taxes adjustments). - Promotions Open Api - [Get All Promotions](https://open-api-docs.guesty.com/reference/promotioncontroller_getlist.md): Retrieves all eligible, ongoing, and expired promotions on the account. - [Assign Properties to a Promotion.](https://open-api-docs.guesty.com/reference/promotioncontroller_assignlistings.md): Assigns properties to participate in a promotion. - [Unassign Properties from a Promotion.](https://open-api-docs.guesty.com/reference/promotioncontroller_unassignlistings.md): Removes properties from participating in the promotion. - [Get promotion listings](https://open-api-docs.guesty.com/reference/promotioncontroller_getassignedlistingids.md): Get listing IDs assigned to a promotion. - Properties Logs - [Get property logs](https://open-api-docs.guesty.com/reference/getpropertylogs.md): Retrieve logs for a specific property with optional filtering and pagination - Property Media - [Get Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_getvirtualtour.md): Retrieve the virtual tour URL for a specific property - [Create Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_createvirtualtour.md): Insert a 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 Virtual Tour URL](https://open-api-docs.guesty.com/reference/propertymediacontroller_deletevirtualtour.md): Remove the virtual tour URL from a specific property - Property Photos - [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. - [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. - [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. - [Replace photo or edit caption without changing order or room assignment.](https://open-api-docs.guesty.com/reference/edit.md): Edit a Photo - [Delete a Photo](https://open-api-docs.guesty.com/reference/delete1.md): Delete a specific photo from a given property. - [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. - Quotes Open Api [Beta] - [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… - [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… - [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. - [Add coupons to an existing quote](https://open-api-docs.guesty.com/reference/quotesopenapicontroller_changecoupons.md): Add coupons to an existing quote - RateStrategyOpenApi - [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. - [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. - Recorded Payments - [Record offline payment](https://open-api-docs.guesty.com/reference/paymentsrecordedrecord.md): Records an offline payment on a reservation without charging a processor. Replaces recorded payments created through the deprecated [Record or process a reservation… - [Update recorded payment](https://open-api-docs.guesty.com/reference/paymentsrecordedupdate.md): Updates a recorded payment. Sending a recorded payment method on a failed processor payment marks it as recorded: status becomes `SUCCEEDED` and `paidAt` is set to the current date and time. - [Record offline refund](https://open-api-docs.guesty.com/reference/paymentsrecordedrefundrecord.md): Records an offline refund on a succeeded recorded payment. Replaces recorded refunds created through the deprecated [Record or process a reservation… - [Update recorded refund](https://open-api-docs.guesty.com/reference/paymentsrecordedrefundupdate.md): Updates a recorded refund. - Reservations - [List reservations](https://open-api-docs.guesty.com/reference/reservationsv2list.md): Retrieve all reservations or a filtered subset of them. **Note:** This endpoint is soon to be deprecated. Please use [this… - [Create a reservation](https://open-api-docs.guesty.com/reference/reservationsv2create.md): Use this request to create a direct booking. **Note:** This endpoint is soon to be deprecated. Please use [this… - [Get a reservation](https://open-api-docs.guesty.com/reference/reservationsv2get.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`,… - [Update a reservation](https://open-api-docs.guesty.com/reference/reservationsv2update.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… - [Record or process a reservation payment](https://open-api-docs.guesty.com/reference/reservationsv2paymentcreate.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 recorded payment indicates… - [Create an invoice item](https://open-api-docs.guesty.com/reference/reservationsv2invoiceitemscreate.md): For creating new invoice item use the new API - [Update or cancel a pending payment](https://open-api-docs.guesty.com/reference/reservationsv2paymentupdate.md): Use this request to update or cancel an upcoming payment. To cancel, set the the payment status to `CANCELLED`. **Note:** This endpoint will be deprecated as part of the move to the Reservations… - [Refund a payment](https://open-api-docs.guesty.com/reference/reservationsv2paymentrefundcreate.md): Use this endpoint to refund a guest's payment charged on an existing reservation. **Note:** This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the… - [Cancel a pending or recorded payment](https://open-api-docs.guesty.com/reference/reservationsv2paymentcancelupdate.md): Use this endpoint to cancel a pending or recorded payment **Note:** This endpoint will be deprecated as part of the move to the Reservations Open API [Beta] (v3). See the [Reservations V3 Booking… - [Download a reservation list as a CSV](https://open-api-docs.guesty.com/reference/reservationsv2listcsvdownload.md): Use this request to export a custom list of reservations as CSV file. Results are limited to 500 reservations per a request. **Note:** This endpoint will be deprecated as part of the move to the… - [Email a reservation list](https://open-api-docs.guesty.com/reference/reservationsv2listemailsend.md): Use this request to export a custom list of reservations in an Email. Results are limited to 250 reservations per a request. **Note:** This endpoint will be deprecated as part of the move to the… - [Approve a pending booking request](https://open-api-docs.guesty.com/reference/reservationsv2bookingrequestapprove.md): Use this call to accept a pending reservation request. Only reservation with status 'reserved' can be approved. **Note:** This endpoint is soon to be deprecated. Please use [this… - [Decline a pending booking request](https://open-api-docs.guesty.com/reference/reservationsv2bookingrequestdecline.md): Use this call to deny a pending reservation request. Only reservation with status 'reserved' can be declined. **Note:** This endpoint is soon to be deprecated. Please use [this… - [List a reservation's populated custom field values](https://open-api-docs.guesty.com/reference/reservationsv2customfieldlist.md): For retrieving custom fields, use the new API - [Update a reservation's custom field values](https://open-api-docs.guesty.com/reference/reservationsv2customfieldupdate.md): For updating custom fields, use the new API - [Get a reservation's custom field value](https://open-api-docs.guesty.com/reference/reservationsv2customfieldget.md): For retrieving a specific custom field, use the new API - [Delete a reservation's custom field value](https://open-api-docs.guesty.com/reference/reservationsv2customfielddelete.md): For deleting a specific custom field, use the new API - [Request an airbnb reservation cancellation](https://open-api-docs.guesty.com/reference/reservationsv2requestairbnbcancellationpost.md): Use this call to request a new reservation cancellation from your guest. **Note:** This endpoint is soon to be deprecated. Please use [this… - Reservations Open Api [Beta] - [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. - [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… - [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… - [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. - [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 - [Change Reservation Guest Stay Status](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_changestay.md): Change the guest stay status of the reservation - [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 notes](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationnotes.md): Update reservation notes, including the key code and special requests fields - [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 - [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 listing](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationlisting.md): Change a listing for specific reservations. - [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 confirmation code](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_updatereservationconfirmationcode.md): Update the confirmation code of a reservation - [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 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 - [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… - [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. - [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 - [Delete reservation's Custom Field](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_deletereservationcustomfield.md): Delete an existing custom field from a reservation. - [Create a mid-stay](https://open-api-docs.guesty.com/reference/reservationsopenapicontroller_createmidstay.md): Relocate guests to a different listing during their stay - [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,… - [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… - [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)… - [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. - [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. - [Create a reservation comment](https://open-api-docs.guesty.com/reference/reservationcommentsopenapicontroller_createcomment.md): Create an internal reservation comment or reply - [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. - [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. - Reservation Payments - [List reservation payments](https://open-api-docs.guesty.com/reference/paymentsreservationlist.md): Returns every payment on the given reservation, including authorization holds and their capture payments, plus reservation payment summary fields. - [Create payment](https://open-api-docs.guesty.com/reference/paymentsreservationcreate.md): Creates a payment on a reservation. Replaces the deprecated [Record or process a reservation payment](https://open-api-docs.guesty.com/reference/reservationsv2paymentcreate) for processor payments. - [Get payment](https://open-api-docs.guesty.com/reference/paymentsreservationget.md): Returns a single payment by ID. - [Update payment](https://open-api-docs.guesty.com/reference/paymentsreservationupdate.md): Updates `amount`, `paymentMethodId`, `shouldBePaidAt`, or `note` on a processor payment. Recorded payments must use `PATCH /payments/{paymentId}/record`. Replaces the deprecated [Update or cancel a… - [Charge payment](https://open-api-docs.guesty.com/reference/paymentsreservationcharge.md): Charges a payment now. The payment must be `PENDING` (including one scheduled for later) or `FAILED`. Recorded payments are not charged here. A provider decline returns 200 with status `FAILED`. When… - [Cancel payment](https://open-api-docs.guesty.com/reference/paymentsreservationcancel.md): Cancels a payment in status `PENDING` or `PENDING_AUTH`, or a succeeded recorded payment. A payment that already has refunds cannot be cancelled. Replaces the deprecated [Cancel a pending or… - [Refund payment](https://open-api-docs.guesty.com/reference/paymentsreservationrefund.md): Refunds a succeeded processor payment in full or in part. Returns the payment with the refund included in `refunds`. The refund can still be `PROCESSING` until the provider settles it. Replaces the… - [Capture authorization hold](https://open-api-docs.guesty.com/reference/paymentsreservationcapture.md): Captures funds from an authorization hold and returns the new capture payment. The hold and the other reservation payments are available from `GET /payments`. - [Record chargeback](https://open-api-docs.guesty.com/reference/paymentsreservationchargebackrecord.md): Records a chargeback on a succeeded processor payment and returns that payment. Pending payments on the same reservation that used this payment method are detached. Recorded payments are not… - Reservations Reports Open Api [Beta] - [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 - Review - [Create a custom channel](https://open-api-docs.guesty.com/reference/reviewcontroller_createcustomchannel.md): Create a custom channel for an account - [List custom channel names](https://open-api-docs.guesty.com/reference/reviewcontroller_listcustomchannelnames.md): Retrieve a list of custom channel names for the account - [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 - [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 - [Publish a custom-channel review](https://open-api-docs.guesty.com/reference/reviewcontroller_createcustomchannelreview.md): Publish a custom-channel review - [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 - Roles - [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. - [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. - Room Photos - [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. - [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 - Saved Replies - [List saved replies](https://open-api-docs.guesty.com/reference/inboxsavedreplylist.md): Retrieve your account's saved replies as a paginated result set with `results`, `count`, `limit` and `skip`. Saved replies are account-wide unless you pass `listingId`, which returns the ones… - [Create a saved reply](https://open-api-docs.guesty.com/reference/inboxsavedreplycreate.md): Create a saved reply for your account. `question` and `answer` are required. Leave `listingsIds` empty to make the reply account-wide, or list the listings it should apply to. Returns the created… - [Get a saved reply](https://open-api-docs.guesty.com/reference/inboxsavedreplyget.md): Retrieve a single saved reply by its ID. When `fields` is supplied, `_id` and `accountId` are always included in the response alongside the fields you request. - [Update a saved reply](https://open-api-docs.guesty.com/reference/inboxsavedreplyupdate.md): Apply a partial update to a saved reply. Only the fields you send are changed, except arrays such as `listingsIds`, which are replaced wholesale rather than merged. The response echoes back only the… - [Delete a saved reply](https://open-api-docs.guesty.com/reference/inboxsavedreplydelete.md): Delete a saved reply, returning the plain-text body `ok`. If the reply also applies to listings outside the ones you manage, it is not deleted — instead it is detached from your listings and kept for… - [List saved replies by listing](https://open-api-docs.guesty.com/reference/inboxsavedreplylistinglist.md): Returns saved replies filtered by the listing id. By default only ids are returned. - Spaces - [List bed-types](https://open-api-docs.guesty.com/reference/get_properties-spaces-bed-types.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) - [Retrieve spaces for a complex](https://open-api-docs.guesty.com/reference/get_properties-spaces-complex-complexid.md) - [Add space to unit-type (Create Space)](https://open-api-docs.guesty.com/reference/post_properties-spaces-unit-type-unittypeid-add.md) - [Edit space details](https://open-api-docs.guesty.com/reference/patch_properties-spaces-space-spaceid-details.md) - [Remove space from unit-type](https://open-api-docs.guesty.com/reference/post_properties-spaces-space-spaceid-remove.md) - [Edit space beds](https://open-api-docs.guesty.com/reference/post_properties-spaces-space-spaceid-edit.md) - Tasks - [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) - [Get a specific task](https://open-api-docs.guesty.com/reference/get_tasks-open-api-taskid.md) - [Delete a task](https://open-api-docs.guesty.com/reference/delete_tasks-open-api-taskid.md) - Taxes - [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. - [Get tax level configuration](https://open-api-docs.guesty.com/reference/taxeslevelconfigurationscontroller_getunittypetaxeslevelconfigurations.md): Get tax level configuration - [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. - [Update tax](https://open-api-docs.guesty.com/reference/openapitaxescontroller_updatetax.md): Update tax by id. - [Get account level taxes](https://open-api-docs.guesty.com/reference/openapitaxescontroller_getaccountleveltaxes.md): Get account level taxes - [Get unit type (parent unit) level taxes](https://open-api-docs.guesty.com/reference/openapitaxescontroller_getunittypeleveltaxes.md): Get unit type (parent unit) 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) - Users - [List all users](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_getusers.md): List all users - [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. - [Update user](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_updateuser.md): Update user by ID - [Delete user](https://open-api-docs.guesty.com/reference/openapiusershttpcontroller_removeuser.md): Delete user by ID - User scope - [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. - Vendors (only available for accounting add-on users) - [Query vendors](https://open-api-docs.guesty.com/reference/vendorscontroller_getall.md): Get a list of vendors - [Create vendor](https://open-api-docs.guesty.com/reference/vendorscontroller_create.md): Create a new vendor - [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 - Views - [List saved views](https://open-api-docs.guesty.com/reference/accountsviewlist.md): Retrieve all your saved listing or reservation views. The `section` query parameter is required; a request without it is rejected with 400. Results combine your account's own views with Guesty's… - [Create a view](https://open-api-docs.guesty.com/reference/accountsviewcreate.md): Create a saved view for a section. `title` and `section` are both required. The new view is owned by the authenticated user and scoped to their account. Returns the created view. Use 'Update view' to… - [Get a saved view](https://open-api-docs.guesty.com/reference/accountsviewget.md): Retrieve a single saved view by its ID. Guesty's predefined views are available to any caller; a view belonging to another account returns 403, and an unknown ID returns 404. Use `fields` to limit… - [Update a saved view](https://open-api-docs.guesty.com/reference/accountsviewupdate.md): Apply a partial update to one of your account's saved views. Only the fields you send are changed, except arrays such as `filters` and `columns`, which are replaced wholesale rather than merged.… - [Delete a view](https://open-api-docs.guesty.com/reference/accountsviewdelete.md): Delete one of your account's saved views. You must be the view's owner, or hold permission to manage all views, otherwise the request returns 403. Guesty's predefined views cannot be deleted and… - Webhooks - [List webhook subscriptions](https://open-api-docs.guesty.com/reference/accountswebhooklist.md): Retrieve every webhook subscription registered under your account, including the destination URL and the list of events each one is subscribed to. - [Create a webhook subscription](https://open-api-docs.guesty.com/reference/accountswebhookcreate.md): Subscribe a destination URL to one or more Guesty events. At least one event is required, and every event name must be one of the supported values — an unrecognized name is rejected with 400. An… - [Get a Webhook subscription](https://open-api-docs.guesty.com/reference/accountswebhookget.md): Retrieve a single webhook subscription by its ID, including its destination URL and subscribed events. Only webhooks belonging to your account are returned. - [Update a webhook subscription](https://open-api-docs.guesty.com/reference/accountswebhookupdate.md): Replace the set of events a webhook is subscribed to. The destination URL is fixed at creation — sending a different `url` is rejected with 400, so create a new webhook instead. At least one valid… - [Delete a webhook subscription](https://open-api-docs.guesty.com/reference/accountswebhookdelete.md): Permanently remove a webhook subscription, stopping all further event deliveries to its destination URL. Returns 204 whether or not a matching webhook existed under your account. - [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-10-21](https://open-api-docs.guesty.com/changelog/2026-10-21.md) - [2026-10-18](https://open-api-docs.guesty.com/changelog/2026-10-18.md) - [2026-10-06](https://open-api-docs.guesty.com/changelog/2026-10-06.md) - [2026-09-30](https://open-api-docs.guesty.com/changelog/2026-09-30.md) - [2026-09-16](https://open-api-docs.guesty.com/changelog/2026-09-15.md) - [2026-09-02](https://open-api-docs.guesty.com/changelog/2026-09-02.md) - [2026-08-26](https://open-api-docs.guesty.com/changelog/2026-08-26.md) - [2026-08-20](https://open-api-docs.guesty.com/changelog/2026-08-20.md) - [2026-08-12](https://open-api-docs.guesty.com/changelog/2026-08-12.md) - [2026-07-30 - Mark legacy resources for deprecation](https://open-api-docs.guesty.com/changelog/2026-07-30.md)