Jump to Content
Home
Guides
Recipes
API Reference
Changelog
API Reference
Home
Guides
Recipes
API Reference
Changelog
How to Use The API Reference
All
Pages
Start typing to search…
JUMP TO
Getting Started
How to Use The API Reference
Get Started
Authentication
Response Codes
GUESTY OPEN API
Account Brands
Get brand by property_id.
get
Accounting (only available for accounting add-on users)
Get folio balances
get
Get recognized journal entries
get
Get all journal entries
get
Get owner working capital
get
Update owner working capital
put
Get categories list
get
Assign listings to Business Models
put
Get Business Models
get
Create owner charge per owner
post
Create owner charges by listing
post
Create expense
post
Create expense by listing
post
Accounts
Get account details of current user.
get
Get All Custom Fields
get
Create new custom field
post
Update custom field
put
Get Custom Field
get
Delete Custom Field
del
AdditionalFees
Create additional fee on account level
post
Get list of additional fees for account
get
Create additional fee on listing level
post
Get list of additional fees for listing
get
Update existing additional fee
patch
Delete existing additional fee
del
Calculate additional fee amount for quote [Beta]
post
Add upsell fee to inquiry rate plans quotes [Beta]
post
Address
Retrieve Property Address
get
Geocode Location by Full Address
post
Update Property Address
put
Update Complex Address
put
Airbnb Listing Expectations
Upsert Airbnb listing expectations
put
Retrieve Airbnb listing expectations
get
Airbnb Resolution Center
List closed airbnb resolutions for reservation
get
Amenities
Get a List of All Supported Amenities
get
Get a List Of All Available Amenity Groups
get
Retrieve Property Amenities
get
Set Amenities For Property
put
Calendar
Retrieve the calendar for a single listing
get
Update the calendar for a single listing
put
Retrieve the optimized calendar for a single listing
get
Retrieve calendars for multiple listings
get
Update calendar for multiple listings
put
Calendar Logs
Get calendar block logs
get
Calendar Sync (iCal export)
Create exported calendar link
post
Get active exported calendar
get
Get a specific exported calendar
get
Update exported calendar
put
Delete exported calendar
del
Calendar Sync (iCal import)
Get imported calendar by id
get
Update imported calendar
put
Delete imported calendar
del
Get imported calendars list
get
Import a calendar
post
Unsync imported calendar
post
Resume imported calendar sync
post
Channel Commission
Update account channel commission
put
Get account channel commission
get
Update listings channel commission
put
Get listings channel commission
get
Update account channel commission
put
Get account channel commission
get
Update listings channel commission
put
Get listings channel commission
get
Complexes
Get a list of all complexes
get
Create a new complex
post
Get complex
get
Update complex details
put
Delete complex
del
Assign propertyIds to a complex
put
Un-Assign propertyIds from a complex
put
Custom Fields
List Custom Fields per Property
get
Update property Custom Fields
put
Get Custom Field from Selected Property
get
Delete Custom Field from property
del
Expenses (only available for accounting add-on users)
Get expenses with filtering
get
Create expense
post
Get expense by ID
get
Cancel expense
post
Add attachments to expense
post
Group Reservations Open Api [Beta]
Get group reservation by group id
get
Create a group reservation
post
Guest app
Get check-in form summary by reservation id
get
Guests
Create guest
post
Get guests list
get
Update guest
put
Get guest by id
get
Create payment method
post
List guest's payment methods
get
Guesty Locks Manager
Get guest code
get
House Rules
Retrieve unit-type house-rules
get
Update unit-type house-rules
put
List house rules
get
Update multiple unit-type house-rules
post
Inbox Conversations
Get conversations
get
Get conversation by id
get
Get posts (by conversation id)
get
Post msg to conversation without sending it
post
Post msg(Send new msg)
post
Integrations
List all integrations
get
Create integration
post
Get integration
get
Update integration
put
Invoice Items
Create Invoice Item
post
Listings
Retrieve all listings
get
Create a listing
post
Retrieve a listing
get
Update a listing
put
Delete a listing
del
Update listings availability settings
put
List all cities
get
List all tags
get
Retrieve a listing's paymentProviderId
get
Export as CSV
post
Send results in email
post
Get all listing's custom fields
get
Update listing's Custom Fields
put
Get custom field-Listings
get
Delete listing's custom fields
del
Retrieve listing Financials
get
Update listing Financials
put
Marketing fields
Get a list of translation fields
get
[Beta] Get a list of translation fields per channel
get
[Beta] Get a list of translation fields per description set.
get
Upsert translation
put
Retrieve a list of supported languages.
get
[Beta] Retrieve a list of supported languages for specific listing
get
[Beta] upsert supported languages for specific listing
put
Retrieve a list of supported channels.
get
[Beta] Get a list of description sets.
get
[Beta] Create Description Set.
post
[Beta] Update Description Set.
put
[Beta] Delete Description Set.
del
Open Api Ari Calendar v1
GET Rate Plan Calendar
get
Upsert Rate Plan ARI Calendar
put
Open Api Rate Plan CRUD v1
Get All Rate Plans
get
Create a Rate Plan
post
Get a Rate Plan by ID
get
Update a Rate Plan
put
patch rate plan
patch
Remove a Rate Plan
del
Assign Properties to a Rate Plan
put
Unassign Properties from a Rate Plan
put
Get Rate Plans by Property
get
Owners
Create multiple owners with assigned listings
post
Get list of owners
get
Create an owner
post
Get owner
get
Update owner
put
Delete owner
del
Owners Documents
Get list of documents
get
Create a document
post
Get document
get
Update document
patch
Delete document
del
Download document
get
Owners Reservations
List owners reservations
get
Retrieve an owner reservation
get
Update an owner reservation
put
Ownerships
Get listing ownerships
get
Set ownerships to listing
put
Get owner listings ownerships
get
Payment providers
Assign listings to Stripe account
post
Get summary
get
Get default payment provider
get
Get provider stats
get
Get payment provider by id
get
Get payment provider by listing id
get
Payment Transactions [Beta]
Get transactions from Guesty Pay providers [Beta]
get
Get payouts reconciliation data from Guesty Pay providers [Beta]
get
Phone Book Entries
Create a new contact
post
List all contacts
get
Get a specific contact
get
Update a contact
put
Delete a contact
del
Pre-approve inquiry
Pre-approve an existing inquiry (Airbnb)
post
Price Adjustments
Create a total amount price adjustments
post
Get all total amount price adjustments for a reservation
get
Promotions Open Api
Get All Promotions
get
Assign Properties to a Promotion.
put
Unassign Properties from a Promotion.
put
Get promotion listings
get
Properties Logs
Get property logs
get
Property Media
Get Virtual Tour URL
get
Create Virtual Tour URL
post
Update Virtual Tour URL
put
Delete Virtual Tour URL
del
Property Photos
Retrieve all photos for a given listing.
get
Add new photos to property
post
Change the photo order on a property
post
Replace photo or edit caption without changing order or room assignment.
post
Delete a Photo
del
Upload a photo to property using file blob
post
Quotes Open Api [Beta]
Retrieve a Quote by ID
get
Create a Quote
post
Create multiple quotes for reservation
post
Add coupons to an existing quote
post
RateStrategyOpenApi
Retrieve All Rate Strategies.
get
Retrieve Property's Rate Strategy.
get
Reservations
Search reservations
get
Create a reservation
post
Retrieve a reservation
get
Update a reservation
put
Add a payment to reservation
post
Create new Invoice item
post
Update or cancel a payment for reservation
put
Refund an existing payment
post
Cancels a pending or recorded payment
patch
Export as CSV
post
Send results in email
post
Approve a pending booking request
post
Decline a pending booking request
post
Retrieve all populated custom fields on an existing reservation.
get
Update reservation's Custom Fields
put
Get custom field - Reservations
get
Delete reservation's custom fields
del
Request airbnb reservation cancellation on the platform
post
Reservations Open Api [Beta]
Create a reservation from quote
post
Create a confirmed owner reservation
post
Create a Reservation Without a Quote
post
Retrieve Reservations
get
Change Reservation Guest Stay Status
put
Change Reservation Source
put
Update Reservation notes
put
Update Reservation Dates
put
Update reservation listing
put
Update reservation status
put
Update reservation confirmation code
put
Update Reservation Guests Breakdown
put
Update reservation's Custom Fields
put
Get all custom fields for a reservation
get
Get a specific custom field for a reservation
get
Delete reservation's Custom Field
del
Create a mid-stay
post
Approve a channel reservation
post
Decline a channel reservation
post
Pre-approve a channel reservation
post
Request cancellation of a channel reservation
post
Reservations Reports Open Api [Beta]
Get reservations report by view id
get
Review
Retrieve reviews sorted descending by last update time
get
Publish a review by channel
put
Retrieve Average reviews score by Listings IDs
get
Retrieve a review
get
Publish review reply to channel
put
Room Photos
List All Room Photos per Property
get
Assign a Photo to a Space
put
Unassign a Photo from a Space
put
Retrieve a Room Photo by ID
get
Saved Replies
Get saved replies
get
Post saved reply
post
Get saved reply by id
get
Update saved reply by id
put
Delete saved reply by id
del
Get saved replies by listing id
get
Spaces
List bed-types
get
List room-types
get
Retrieve spaces for a unit-type
get
Retrieve spaces for a complex
get
Add space to unit-type (Create Space)
post
Edit space details
patch
Remove space from unit-type
post
Edit space beds
post
Tasks
Get tasks list
get
Create a new task
post
Update a task
put
Get a specific task
get
Delete a task
del
Taxes
Create or update tax level configuration
put
Get tax level configuration
get
Create tax
post
Delete tax
del
Update tax
patch
Get account level taxes
get
Get unit type (parent unit) level taxes
get
Get actual taxes of unit type (parent unit level)
get
Users
List all users
get
Create user
post
Get user
get
Update user
put
Delete user
del
Vendors (only available for accounting add-on users)
Query vendors
get
Query a vendor
get
Views
Retrieve all views
get
Create a view
post
Retrieve a view
get
Update a view
put
Delete a view
del
Webhooks
List all webhooks
get
Create a Webhook
post
Retrieve a Webhook
get
Update webhook
put
Delete webhook
del
Get webhook secret
get
Powered by
How to Use The API Reference
Ask AI
Use the API Reference to generate requests and responses.
