Jump to Content
Home
API Reference
Changelog
v2.0
v3.0
v3.1
v3.2
Log In
API Reference
Log In
Hermes (V3.2)
Home
API Reference
Changelog
Get transactions for an order.
Search
JUMP TO
Documentation
Getting Started with the Hostfully API v3
Authentication
Authorizing your Integration by a Customer
V2 -> V3 Migration Guide
V1.5 -> V3 Migration Guide
Leads flow
Retrieve lead's submitted pre-arrival form
V3.1 - Multi Units
V3.2 - Messaging Update
Version Migration Guide for API V3.X
Webhooks
Hostfully GraphQL API
Hostfully GraphQL Api
Hostfully API
Agencies
Get an agency by UID
get
Get agencies
get
Amenities
Get a specific amenity by UID
get
Update an existing amenity
put
Delete an amenity
delete
Get all amenities.
get
Create a new amenity
post
Available Amenities
Get all available amenities
get
Available Property Rules
Get available property rules
get
Custom Amenities
Get all custom amenities
get
Create a new custom amenity
post
Delete a custom amenity by UID
delete
Custom Data
Get the custom data.
get
Create custom data.
post
Delete custom data.
delete
Custom Data Fields
Get all agency custom data fields
get
Create a custom data field
post
Get a custom data field
get
Delete a custom data field
delete
Employees
Get an employee
get
Update an employee
put
Get all agency employees
get
Extra Guests
Fetch extra guests by lead
get
Fees
Get fee by UID
get
Update an existing fee
put
Delete a fee.
delete
Get all property fees
get
Create a new fee
post
Guests
Get all guests
get
ICals
Get all property ICals
get
Jobs
Get a job
get
Update a job
put
Delete a job
delete
Mark job as done
post
Decline a job
post
Accept a job
post
Fetches jobs by provided filter
get
Create a new job
post
Leads
Reopen inquiry
post
Rebook cancelled booking
post
Place inquiry on hold
post
Mark pre-arrival form completed
post
Transform inquiry to booking
post
Mark lead as ignored
post
Extend hold duration
post
Decline booking request
post
Close lead
post
Cancel booking
post
Alter lead details
post
Accept booking request
post
Search leads with filters
get
Create a new lead
post
Retrieve a lead by UID
get
Delete obsolete lead.
delete
Partially update lead information
patch
Messages
/api/v3.2/messages
get
/api/v3.2/messages
post
/api/v3.2/messages/{messageUid}/resend
post
/api/v3.2/messages/{messageUid}
get
Multi-Unit Properties
List multi-unit properties by agency
get
Create new multi-unit property
post
Get multi-unit property by UID
get
Delete multi-unit property
delete
Update multi-unit property
patch
Orders
Get orders with filters
get
Owner Adjustments
Get owner adjustment by UID
get
Update owner adjustment
put
Delete owner adjustment
delete
Get owner adjustments by property
get
Create owner adjustment
post
Owners
Get owner details
get
Remove owner from agency
delete
Update owner information
patch
List owners by agency
get
Photos
Replace photo
put
Delete photo
delete
Update photo metadata
patch
Get photos for single/multi-unit property
get
Upload new photo
post
Delete multiple photos
delete
Pin Codes
Update pin code
put
Delete pin code
delete
List pin codes
get
Create pin code
post
Pricing Periods
Get pricing periods
get
Modify pricing period
post
Pricing Periods Bulk
Bulk update pricing
post
Check bulk update status
get
Properties
Get property details
get
Full property update
put
Delete property
delete
Partial property update
patch
List properties by agency
get
Create new property
post
Property Calendar
Get property calendar
get
Get multiple property calendars
get
Property Channel Links
Get channel link details
get
Update channel link
put
Delete channel link
delete
List channel links
get
Create channel link
post
Property Descriptions
Update property description
put
Delete property description
delete
Get property descriptions
get
Property Ownership
View the owner of a property. This endpoint is only allowed for manager role with read access on the property
get
Delete the owner of a property. This endpoint is only allowed for manager role with edit access on the property
delete
Set or modify the owner of a property. This endpoint is only allowed for manager role with edit access on the property
patch
Property Pricing Rules
Get pricing rules
get
Update pricing rules
put
Property Rules
Get rule details
get
Update property rule
put
Delete property rule
delete
Modify property rule
patch
List property rules
get
Create property rule
post
Quote
Calculate quote
post
Rate Multipliers
Get rate multipliers for active channels
get
Update rate multipliers for active channels. If a value for some channel is not specified, then the rate multiplier for the channel will be kept unchanged.
patch
Reviews
Get review details
get
Update guest review
put
Delete guest review
delete
List guest reviews
get
Create guest review
post
Get review statistics
get
Reviews-Bulk
Create reviews in bulk. The max number of reviews allowed is 100
post
Rooms
Get room details
get
Update room
put
Delete room
delete
List property rooms
get
Create room
post
Rooms Bulk
This operation adds new or updates existing property rooms. Deletes existing rooms that are not specified on the rooms list.
put
Service Providers
Get service provider
get
Update service provider
put
Delete service provider
delete
List service providers
get
Create service provider
post
Services
Get service details
get
Update service
put
List services
get
Create service
post
Sub Units
Get the sub-units for an Agency.
get
Tags
Get tags for object
get
Set tags for object
put
Remove tag for object
delete
Threads
List threads
get
Get thread details
get
Transactions
Get transactions for an order.
get
Create transaction for an order.
post
Get transaction by unique ID.
get
Unit types
Get unit type details
get
Delete unit type
delete
Update unit type
patch
List unit types
get
Units
Get unit details
get
List units by type
get
Version
Update API version
put
Get API version
get
Webhooks
Get webhooks by affiliate id for a partner integration or agencyUid. When using agencyUid filter, an extra optional 'objectUid' parameter can be added to be used as second filter.
get
Create webhook
post
Get webhook details
get
Delete webhook
delete
direct-booking-website-public-api-controller
Get property DBS settings
get
Get agency DBS settings
get
graph-ql-controller
Execute a GraphQL query
post
Powered by
Get transactions for an order.
get
https://sandbox.hostfully.com/api/v3.2/transactions
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
