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
/api/v3.2/amenities/{uid}
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
/api/v3.2/agencies/{uid}
get
Get agencies that the api client is authorized to access.
get
Amenities
/api/v3.2/amenities/{uid}
get
/api/v3.2/amenities/{uid}
put
/api/v3.2/amenities/{uid}
delete
/api/v3.2/amenities
get
/api/v3.2/amenities
post
Available Amenities
/api/v3.2/available-amenities
get
Available Property Rules
/api/v3.2/available-property-rules
get
Custom Amenities
/api/v3.2/custom-amenities
get
/api/v3.2/custom-amenities
post
/api/v3.2/custom-amenities/{uid}
delete
Custom Data
Get the custom data. One of 'propertyUid' or 'leadUid' request parameters is required.
get
Create custom data. One of 'propertyUid' or 'leadUid' is required.
post
Delete custom data of a property or lead. The custom data is identified by 'customDataFieldUid' and one of 'propertyUid' or 'leadUid'
delete
Custom Data Fields
/api/v3.2/custom-data-fields
get
/api/v3.2/custom-data-fields
post
/api/v3.2/custom-data-fields/{customDataFieldUid}
get
/api/v3.2/custom-data-fields/{customDataFieldUid}
delete
Employees
/api/v3.2/employees/{employeeUid}
get
/api/v3.2/employees/{employeeUid}
put
/api/v3.2/employees
get
Extra Guests
/api/v3.2/extra-guests/{leadUid}
get
Fees
/api/v3.2/fees/{uid}
get
/api/v3.2/fees/{uid}
put
/api/v3.2/fees/{uid}
delete
/api/v3.2/fees
get
/api/v3.2/fees
post
Guests
/api/v3.2/guests/{agencyUid}
get
ICals
/api/v3.2/icals
get
Jobs
/api/v3.2/jobs/{jobUid}
get
/api/v3.2/jobs/{jobUid}
put
/api/v3.2/jobs/{jobUid}
delete
/api/v3.2/jobs/{jobUid}/mark-as-done
post
/api/v3.2/jobs/{jobUid}/decline
post
/api/v3.2/jobs/{jobUid}/accept
post
Fetches jobs by provided filter
get
/api/v3.2/jobs
post
Leads
/api/v3.2/leads/{leadUid}/reopen
post
/api/v3.2/leads/{leadUid}/rebook
post
/api/v3.2/leads/{leadUid}/put-on-hold
post
Pre arrival form is a form that is filled in by guest upon Property Manager request with details about the stay, such as exact arrival/departure times, rental agreement signatures and populating custom-data fields.
post
/api/v3.2/leads/{leadUid}/mark-as-booked
post
/api/v3.2/leads/{leadUid}/ignore
post
/api/v3.2/leads/{leadUid}/extend-hold
post
/api/v3.2/leads/{leadUid}/decline-booking-request
post
/api/v3.2/leads/{leadUid}/close
post
/api/v3.2/leads/{leadUid}/cancel
post
/api/v3.2/leads/{leadUid}/alteration
post
/api/v3.2/leads/{leadUid}/accept-booking-request
post
/api/v3.2/leads
get
/api/v3.2/leads
post
/api/v3.2/leads/{leadUid}
get
Delete obsolete lead.
delete
/api/v3.2/leads/{leadUid}
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
/api/v3.2/multi-units/multi-unit-properties
get
/api/v3.2/multi-units/multi-unit-properties
post
/api/v3.2/multi-units/multi-unit-properties/{uid}
get
/api/v3.2/multi-units/multi-unit-properties/{uid}
delete
/api/v3.2/multi-units/multi-unit-properties/{uid}
patch
Orders
/api/v3.2/orders
get
Owner Adjustments
/api/v3.2/owner-adjustments/{uid}
get
/api/v3.2/owner-adjustments/{uid}
put
/api/v3.2/owner-adjustments/{uid}
delete
/api/v3.2/owner-adjustments
get
/api/v3.2/owner-adjustments
post
Owners
/api/v3.2/owners/{ownerUid}
get
/api/v3.2/owners/{ownerUid}
delete
/api/v3.2/owners/{ownerUid}
patch
/api/v3.2/owners
get
Photos
/api/v3.2/photos/{photoUid}
put
/api/v3.2/photos/{photoUid}
delete
/api/v3.2/photos/{photoUid}
patch
/api/v3.2/photos
get
/api/v3.2/photos
post
/api/v3.2/photos
delete
Pin Codes
/api/v3.2/pin-codes/{pinCodeUid}
put
/api/v3.2/pin-codes/{pinCodeUid}
delete
Get the pin codes for a property. One of 'propertyUid' or 'leadUid' request parameters is required.
get
/api/v3.2/pin-codes
post
Pricing Periods
/api/v3.2/pricing-periods
get
/api/v3.2/pricing-periods
post
Pricing Periods Bulk
/api/v3.2/pricing-periods/bulk
post
/api/v3.2/pricing-periods/bulk/{updateTaskUid}
get
Properties
/api/v3.2/properties/{propertyUid}
get
Presumes a full update to the property resource. All fields need to be present.
put
/api/v3.2/properties/{propertyUid}
delete
Provides ability to partially update property resource. Not all fields need to be present
patch
/api/v3.2/properties
get
/api/v3.2/properties
post
Property Calendar
/api/v3.2/property-calendar/{propertyUid}
get
/api/v3.2/property-calendar
get
Property Channel Links
/api/v3.2/property-channel-links/{uid}
get
/api/v3.2/property-channel-links/{uid}
put
/api/v3.2/property-channel-links/{uid}
delete
/api/v3.2/property-channel-links
get
/api/v3.2/property-channel-links
post
Property Descriptions
Create or update the description of a property. The description is identified by 'propertyUid' and 'locale'
put
Delete the description of a property. The description is identified by 'propertyUid' and 'locale'
delete
/api/v3.2/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
/api/v3.2/property-pricing-rules/{propertyUid}
get
/api/v3.2/property-pricing-rules/{propertyUid}
put
Property Rules
/api/v3.2/property-rules/{uid}
get
/api/v3.2/property-rules/{uid}
put
/api/v3.2/property-rules/{uid}
delete
/api/v3.2/property-rules/{uid}
patch
/api/v3.2/property-rules
get
/api/v3.2/property-rules
post
Quote
/api/v3.2/quotes
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
/api/v3.2/reviews/{reviewUid}
get
/api/v3.2/reviews/{reviewUid}
put
/api/v3.2/reviews/{reviewUid}
delete
Get the guest reviews for a property. One of 'propertyUid' or 'leadUid' request parameters is required.
get
/api/v3.2/reviews
post
/api/v3.2/reviews/statistics
get
Reviews-Bulk
Create reviews in bulk. The max number of reviews allowed is 100
post
Rooms
/api/v3.2/rooms/{roomUid}
get
/api/v3.2/rooms/{roomUid}
put
/api/v3.2/rooms/{roomUid}
delete
/api/v3.2/rooms
get
/api/v3.2/rooms
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
/api/v3.2/service-providers/{serviceProviderUid}
get
/api/v3.2/service-providers/{serviceProviderUid}
put
/api/v3.2/service-providers/{serviceProviderUid}
delete
/api/v3.2/service-providers
get
/api/v3.2/service-providers
post
Services
/api/v3.2/services/{serviceUid}
get
/api/v3.2/services/{serviceUid}
put
/api/v3.2/services
get
/api/v3.2/services
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
/api/v3.2/threads
get
/api/v3.2/threads/{threadUid}
get
Transactions
Get transactions for an order.
get
Create transaction for an order.
post
Get transaction by unique ID.
get
Unit types
/api/v3.2/multi-units/unit-types/{unitTypeUid}
get
/api/v3.2/multi-units/unit-types/{unitTypeUid}
delete
Provides ability to partially update unit type resource. Not all fields need to be present
patch
/api/v3.2/multi-units/unit-types
get
Units
/api/v3.2/multi-units/units/{uid}
get
/api/v3.2/multi-units/units
get
Version
/api/version/{newApiVersion}
put
/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
/api/v3.2/webhooks
post
/api/v3.2/webhooks/{webhookUid}
get
/api/v3.2/webhooks/{webhookUid}
delete
direct-booking-website-public-api-controller
/api/v3.2/dbs/properties/{propertyUid}
get
/api/v3.2/dbs/agencies/{agencyUid}
get
graph-ql-controller
/api/v3.2/graphql
post
Powered by
/api/v3.2/amenities/{uid}
put
https://sandbox.hostfully.com/api/v3.2/amenities/
{uid}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
