Jump to Content

Home API Reference Changelog

API Reference

Home API Reference Changelog

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

Hostfully GraphQL API

Hostfully GraphQL Api

Hostfully API

Agencies
- /api/v3.1/agencies/{uid}get
- Get agencies that the api client is authorized to access.get
Amenities
Available Amenities
- /api/v3.1/available-amenitiesget
Available Property Rules
- /api/v3.1/available-property-rulesget
Custom Amenities
Custom Data
Custom Data Fields
Employees
Extra Guests
- /api/v3.1/extra-guests/{leadUid}get
Fees
Guests
- /api/v3.1/guests/{agencyUid}get
ICals
- /api/v3.1/icalsget
Jobs
Leads
Local Spots
Messages
- Send message by leadUid. Email or direct message accepted. To send a direct message, the lead must be from an available direct message channel (VRBO/Booking.com/AirBnb).post
- /api/v3.1/messages/{leadUid}get
Multi-Unit Properties
Orders
- /api/v3.1/ordersget
Owner Adjustments
Owners
Photos
Pin Codes
Pricing Periods
- /api/v3.1/pricing-periodsget
- /api/v3.1/pricing-periodspost
Pricing Periods Bulk
- /api/v3.1/pricing-periods/bulkpost
- /api/v3.1/pricing-periods/bulk/{updateTaskUid}get
Properties
Property Calendar
- /api/v3.1/property-calendar/{propertyUid}get
- /api/v3.1/property-calendarget
Property Channel Links
Property Descriptions
Property Ownership
Property Pricing Rules
- /api/v3.1/property-pricing-rules/{propertyUid}get
- /api/v3.1/property-pricing-rules/{propertyUid}put
Property Rules
Quote
- /api/v3.1/quotespost
Rate Multipliers
- Get rate multipliers for active channelsget
- 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
Reviews-Bulk
- Create reviews in bulk. The max number of reviews allowed is 100post
Rooms
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
Services
Sub Units
- Get the sub-units for an Agency.get
Tags
Transactions
Unit types
Units
- /api/v3.1/multi-units/unitsget
- /api/v3.1/multi-units/units/{uid}get
Webhooks
graph-ql-controller
- /api/v3.1/graphqlpost

Powered by

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

Hostfully GraphQL API

Hostfully GraphQL Api

Hostfully API

Agencies
- /api/v3.1/agencies/{uid}get
- Get agencies that the api client is authorized to access.get
Amenities
Available Amenities
- /api/v3.1/available-amenitiesget
Available Property Rules
- /api/v3.1/available-property-rulesget
Custom Amenities
Custom Data
Custom Data Fields
Employees
Extra Guests
- /api/v3.1/extra-guests/{leadUid}get
Fees
Guests
- /api/v3.1/guests/{agencyUid}get
ICals
- /api/v3.1/icalsget
Jobs
Leads
Local Spots
Messages
- Send message by leadUid. Email or direct message accepted. To send a direct message, the lead must be from an available direct message channel (VRBO/Booking.com/AirBnb).post
- /api/v3.1/messages/{leadUid}get
Multi-Unit Properties
Orders
- /api/v3.1/ordersget
Owner Adjustments
Owners
Photos
Pin Codes
Pricing Periods
- /api/v3.1/pricing-periodsget
- /api/v3.1/pricing-periodspost
Pricing Periods Bulk
- /api/v3.1/pricing-periods/bulkpost
- /api/v3.1/pricing-periods/bulk/{updateTaskUid}get
Properties
Property Calendar
- /api/v3.1/property-calendar/{propertyUid}get
- /api/v3.1/property-calendarget
Property Channel Links
Property Descriptions
Property Ownership
Property Pricing Rules
- /api/v3.1/property-pricing-rules/{propertyUid}get
- /api/v3.1/property-pricing-rules/{propertyUid}put
Property Rules
Quote
- /api/v3.1/quotespost
Rate Multipliers
- Get rate multipliers for active channelsget
- 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
Reviews-Bulk
- Create reviews in bulk. The max number of reviews allowed is 100post
Rooms
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
Services
Sub Units
- Get the sub-units for an Agency.get
Tags
Transactions
Unit types
Units
- /api/v3.1/multi-units/unitsget
- /api/v3.1/multi-units/units/{uid}get
Webhooks
graph-ql-controller
- /api/v3.1/graphqlpost

Powered by

/api/v3.1/leads/{leadUid}/close

post https://sandbox.hostfully.com/api/v3.1/leads/{leadUid}/close

Closes the lead.

Language

Credentials

Click Try It! to start a request and see the response here!