JUMP TODocumentationGetting Started with the Hostfully API v3AuthenticationAuthorizing your Integration by a CustomerV2 -> V3 Migration GuideV1.5 -> V3 Migration GuideLeads flowRetrieve lead's submitted pre-arrival formHostfully GraphQL APIHostfully GraphQL ApiHostfully APIAgencies/api/v3/agencies/{uid}getGet agencies that the api client is authorized to access.getAmenities/api/v3/amenities/{uid}get/api/v3/amenities/{uid}put/api/v3/amenities/{uid}delete/api/v3/amenitiesget/api/v3/amenitiespostAvailable 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/employees/{employeeUid}get/api/v3/employees/{employeeUid}put/api/v3/employeesgetExtra Guests/api/v3/extra-guests/{leadUid}getFees/api/v3/fees/{uid}get/api/v3/fees/{uid}put/api/v3/fees/{uid}delete/api/v3/feesget/api/v3/feespostGuests/api/v3/guests/{agencyUid}getICals/api/v3/icalsgetJobs/api/v3/jobs/{jobUid}get/api/v3/jobs/{jobUid}put/api/v3/jobs/{jobUid}delete/api/v3/jobsget/api/v3/jobspostLeads/api/v3/leadsget/api/v3/leadspost/api/v3/leads/{leadUid}/reopenpost/api/v3/leads/{leadUid}/rebookpost/api/v3/leads/{leadUid}/put-on-holdpostPre 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/leads/{leadUid}/mark-as-bookedpost/api/v3/leads/{leadUid}/ignorepost/api/v3/leads/{leadUid}/extend-holdpost/api/v3/leads/{leadUid}/decline-booking-requestpost/api/v3/leads/{leadUid}/closepost/api/v3/leads/{leadUid}/cancelpost/api/v3/leads/{leadUid}/alterationpost/api/v3/leads/{leadUid}/accept-booking-requestpost/api/v3/leads/{leadUid}getDelete obsolete lead.delete/api/v3/leads/{leadUid}patchLocal Spots/api/v3/local-spots/{uid}get/api/v3/local-spots/{uid}put/api/v3/local-spots/{uid}delete/api/v3/local-spotsget/api/v3/local-spotspostMessagesSend 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-adjustments/{uid}get/api/v3/owner-adjustments/{uid}put/api/v3/owner-adjustments/{uid}delete/api/v3/owner-adjustmentsget/api/v3/owner-adjustmentspostOwners/api/v3/owners/{ownerUid}get/api/v3/owners/{ownerUid}delete/api/v3/owners/{ownerUid}patch/api/v3/ownersgetPhotos/api/v3/photos/{photoUid}put/api/v3/photos/{photoUid}delete/api/v3/photosget/api/v3/photospostPin Codes/api/v3/pin-codes/{pinCodeUid}put/api/v3/pin-codes/{pinCodeUid}deleteGet the pin codes for a property. One of 'propertyUid' or 'leadUid' request parameters is required.get/api/v3/pin-codespostPricing 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/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 presentpatch/api/v3/propertiesget/api/v3/propertiespostProperty Calendar/api/v3/property-calendar/{propertyUid}get/api/v3/property-calendargetProperty Channel Links/api/v3/property-channel-links/{uid}get/api/v3/property-channel-links/{uid}put/api/v3/property-channel-links/{uid}delete/api/v3/property-channel-linksget/api/v3/property-channel-linkspostProperty DescriptionsCreate 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'delete/api/v3/property-descriptionsgetProperty 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-rules/{uid}get/api/v3/property-rules/{uid}put/api/v3/property-rules/{uid}delete/api/v3/property-rules/{uid}patch/api/v3/property-rulesget/api/v3/property-rulespostQuote/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.patchReviews/api/v3/reviews/{reviewUid}get/api/v3/reviews/{reviewUid}put/api/v3/reviews/{reviewUid}deleteGet the guest reviews for a property. One of 'propertyUid' or 'leadUid' request parameters is required.get/api/v3/reviewspostReviews-BulkCreate reviews in bulk. The max number of reviews allowed is 100postRooms/api/v3/rooms/{roomUid}get/api/v3/rooms/{roomUid}put/api/v3/rooms/{roomUid}delete/api/v3/roomsget/api/v3/roomspostRooms 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-providers/{serviceProviderUid}get/api/v3/service-providers/{serviceProviderUid}put/api/v3/service-providers/{serviceProviderUid}delete/api/v3/service-providersget/api/v3/service-providerspostServices/api/v3/services/{serviceUid}get/api/v3/services/{serviceUid}put/api/v3/servicesget/api/v3/servicespostSub 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.getWebhooksGet 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}deletegraph-ql-controller/api/v3/graphqlpostPowered by /api/v3/pin-codes/{pinCodeUid}delete https://sandbox.hostfully.com/api/v3/pin-codes/{pinCodeUid}
