JUMP TODocumentationGetting Started with the Hostfully API 3.0AuthenticationAuthorizing your Integration by a CustomerV2 -> V3 Migration GuideV1.5 -> V3 Migration GuideLeads flowRetrieve lead's submitted pre-arrival formHostfully GraphQL APIHostfully GraphQL ApiHostfully APIAgenciesGet agencies that the api client is authorized to access.get/api/v3/agencies/{uid}getAmenities/api/v3/amenitiesget/api/v3/amenitiespost/api/v3/amenities/{uid}get/api/v3/amenities/{uid}put/api/v3/amenities/{uid}deleteAvailable Amenities/api/v3/available-amenitiesgetAvailable Property Rules/api/v3/available-property-rulesgetCustom Amenities/api/v3/custom-amenitiesget/api/v3/custom-amenitiespost/api/v3/custom-amenities/{uid}deleteCustom DataGet the custom data. One of 'propertyUid' or 'leadUid' request parameters is required.getCreate custom data. One of 'propertyUid' or 'leadUid' is required.postDelete custom data of a property or lead. The custom data is identified by 'customDataFieldUid' and one of 'propertyUid' or 'leadUid'deleteCustom Data Fields/api/v3/custom-data-fieldsget/api/v3/custom-data-fieldspost/api/v3/custom-data-fields/{customDataFieldUid}get/api/v3/custom-data-fields/{customDataFieldUid}deleteEmployees/api/v3/employeesget/api/v3/employees/{employeeUid}get/api/v3/employees/{employeeUid}putExtra Guests/api/v3/extra-guests/{leadUid}getFees/api/v3/feesget/api/v3/feespost/api/v3/fees/{uid}get/api/v3/fees/{uid}put/api/v3/fees/{uid}deleteGuests/api/v3/guests/{agencyUid}getICals/api/v3/icalsgetJobs/api/v3/jobsget/api/v3/jobspost/api/v3/jobs/{jobUid}get/api/v3/jobs/{jobUid}put/api/v3/jobs/{jobUid}deleteLeads/api/v3/leadsget/api/v3/leadspost/api/v3/leads/{leadUid}getDelete obsolete lead.delete/api/v3/leads/{leadUid}patch/api/v3/leads/{leadUid}/accept-booking-requestpost/api/v3/leads/{leadUid}/alterationpost/api/v3/leads/{leadUid}/cancelpost/api/v3/leads/{leadUid}/closepost/api/v3/leads/{leadUid}/decline-booking-requestpost/api/v3/leads/{leadUid}/extend-holdpost/api/v3/leads/{leadUid}/ignorepost/api/v3/leads/{leadUid}/mark-as-bookedpost/api/v3/leads/{leadUid}/put-on-holdpost/api/v3/leads/{leadUid}/rebookpost/api/v3/leads/{leadUid}/reopenpostLocal Spots/api/v3/local-spotsget/api/v3/local-spotspost/api/v3/local-spots/{uid}get/api/v3/local-spots/{uid}put/api/v3/local-spots/{uid}deleteMessagesSend 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/messages/{leadUid}getOrders/api/v3/ordersgetOwner Adjustments/api/v3/owner-adjustmentsget/api/v3/owner-adjustmentspost/api/v3/owner-adjustments/{uid}get/api/v3/owner-adjustments/{uid}put/api/v3/owner-adjustments/{uid}deleteOwners/api/v3/ownersget/api/v3/owners/{ownerUid}get/api/v3/owners/{ownerUid}delete/api/v3/owners/{ownerUid}patchPhotos/api/v3/photosget/api/v3/photospost/api/v3/photos/{photoUid}put/api/v3/photos/{photoUid}deletePin CodesGet the pin codes for a property. One of 'propertyUid' or 'leadUid' request parameters is required.get/api/v3/pin-codespost/api/v3/pin-codes/{pinCodeUid}put/api/v3/pin-codes/{pinCodeUid}deletePricing Periods/api/v3/pricing-periodsget/api/v3/pricing-periodspostPricing Periods Bulk/api/v3/pricing-periods/bulkpost/api/v3/pricing-periods/bulk/{updateTaskUid}getProperties/api/v3/propertiesget/api/v3/propertiespost/api/v3/properties/{propertyUid}getPresumes a full update to the property resource. All fields need to be present.put/api/v3/properties/{propertyUid}deleteProvides ability to partially update property resource. Not all fields need to be presentpatchProperty Calendar/api/v3/property-calendarget/api/v3/property-calendar/{propertyUid}getProperty Channel Links/api/v3/property-channel-linksget/api/v3/property-channel-linkspost/api/v3/property-channel-links/{uid}get/api/v3/property-channel-links/{uid}put/api/v3/property-channel-links/{uid}deleteProperty Descriptions/api/v3/property-descriptionsgetCreate or update the description of a property. The description is identified by 'propertyUid' and 'locale'putDelete the description of a property. The description is identified by 'propertyUid' and 'locale'deleteProperty OwnershipView the owner of a property. This endpoint is only allowed for manager role with read access on the propertygetDelete the owner of a property. This endpoint is only allowed for manager role with edit access on the propertydeleteSet or modify the owner of a property. This endpoint is only allowed for manager role with edit access on the propertypatchProperty Pricing Rules/api/v3/property-pricing-rules/{propertyUid}get/api/v3/property-pricing-rules/{propertyUid}putProperty Rules/api/v3/property-rulesget/api/v3/property-rulespost/api/v3/property-rules/{uid}get/api/v3/property-rules/{uid}put/api/v3/property-rules/{uid}delete/api/v3/property-rules/{uid}patchQuote/api/v3/quotespostRate MultipliersGet rate multipliers for active channelsgetUpdate 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.patchReviewsGet the guest reviews for a property. One of 'propertyUid' or 'leadUid' request parameters is required.get/api/v3/reviewspost/api/v3/reviews/{reviewUid}get/api/v3/reviews/{reviewUid}put/api/v3/reviews/{reviewUid}deleteReviews-BulkCreate reviews in bulk. The max number of reviews allowed is 100postRooms/api/v3/roomsget/api/v3/roomspost/api/v3/rooms/{roomUid}get/api/v3/rooms/{roomUid}put/api/v3/rooms/{roomUid}deleteRooms BulkThis operation adds new or updates existing property rooms. Deletes existing rooms that are not specified on the rooms list.putService Providers/api/v3/service-providersget/api/v3/service-providerspost/api/v3/service-providers/{serviceProviderUid}get/api/v3/service-providers/{serviceProviderUid}put/api/v3/service-providers/{serviceProviderUid}deleteServices/api/v3/servicesget/api/v3/servicespost/api/v3/services/{serviceUid}get/api/v3/services/{serviceUid}putSub UnitsGet the sub-units for an Agency.getTagsGet tags for objectgetSet tags for objectputRemove tag for objectdeleteTransactionsGet transactions for an order.getCreate transaction for an order.postGet transaction by unique ID.getWebhookswebhooksExplanationGet 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/webhookspost/api/v3/webhooks/{webhookUid}get/api/v3/webhooks/{webhookUid}deletePowered by /api/v3/rooms/{roomUid}put https://api/v3/rooms/{roomUid}
