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 formV3.1 - Multi UnitsHostfully GraphQL APIHostfully GraphQL ApiHostfully APIAgencies/api/v3.1/agencies/{uid}getGet agencies that the api client is authorized to access.getAmenities/api/v3.1/amenities/{uid}get/api/v3.1/amenities/{uid}put/api/v3.1/amenities/{uid}delete/api/v3.1/amenitiesget/api/v3.1/amenitiespostAvailable Amenities/api/v3.1/available-amenitiesgetAvailable Property Rules/api/v3.1/available-property-rulesgetCustom Amenities/api/v3.1/custom-amenitiesget/api/v3.1/custom-amenitiespost/api/v3.1/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.1/custom-data-fieldsget/api/v3.1/custom-data-fieldspost/api/v3.1/custom-data-fields/{customDataFieldUid}get/api/v3.1/custom-data-fields/{customDataFieldUid}deleteEmployees/api/v3.1/employees/{employeeUid}get/api/v3.1/employees/{employeeUid}put/api/v3.1/employeesgetExtra Guests/api/v3.1/extra-guests/{leadUid}getFees/api/v3.1/fees/{uid}get/api/v3.1/fees/{uid}put/api/v3.1/fees/{uid}delete/api/v3.1/feesget/api/v3.1/feespostGuests/api/v3.1/guests/{agencyUid}getICals/api/v3.1/icalsgetJobs/api/v3.1/jobs/{jobUid}get/api/v3.1/jobs/{jobUid}put/api/v3.1/jobs/{jobUid}delete/api/v3.1/jobsget/api/v3.1/jobspostLeads/api/v3.1/leadsget/api/v3.1/leadspost/api/v3.1/leads/{leadUid}/reopenpost/api/v3.1/leads/{leadUid}/rebookpost/api/v3.1/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.1/leads/{leadUid}/mark-as-bookedpost/api/v3.1/leads/{leadUid}/ignorepost/api/v3.1/leads/{leadUid}/extend-holdpost/api/v3.1/leads/{leadUid}/decline-booking-requestpost/api/v3.1/leads/{leadUid}/closepost/api/v3.1/leads/{leadUid}/cancelpost/api/v3.1/leads/{leadUid}/alterationpost/api/v3.1/leads/{leadUid}/accept-booking-requestpost/api/v3.1/leads/{leadUid}getDelete obsolete lead.delete/api/v3.1/leads/{leadUid}patchLocal Spots/api/v3.1/local-spots/{uid}get/api/v3.1/local-spots/{uid}put/api/v3.1/local-spots/{uid}delete/api/v3.1/local-spotsget/api/v3.1/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.1/messages/{leadUid}getMulti-Unit Properties/api/v3.1/multi-units/multi-unit-propertiesget/api/v3.1/multi-units/multi-unit-propertiespost/api/v3.1/multi-units/multi-unit-properties/{uid}get/api/v3.1/multi-units/multi-unit-properties/{uid}delete/api/v3.1/multi-units/multi-unit-properties/{uid}patchOrders/api/v3.1/ordersgetOwner Adjustments/api/v3.1/owner-adjustments/{uid}get/api/v3.1/owner-adjustments/{uid}put/api/v3.1/owner-adjustments/{uid}delete/api/v3.1/owner-adjustmentsget/api/v3.1/owner-adjustmentspostOwners/api/v3.1/owners/{ownerUid}get/api/v3.1/owners/{ownerUid}delete/api/v3.1/owners/{ownerUid}patch/api/v3.1/ownersgetPhotos/api/v3.1/photos/{photoUid}put/api/v3.1/photos/{photoUid}delete/api/v3.1/photosget/api/v3.1/photospostPin Codes/api/v3.1/pin-codes/{pinCodeUid}put/api/v3.1/pin-codes/{pinCodeUid}deleteGet the pin codes for a property. One of 'propertyUid' or 'leadUid' request parameters is required.get/api/v3.1/pin-codespostPricing Periods/api/v3.1/pricing-periodsget/api/v3.1/pricing-periodspostPricing Periods Bulk/api/v3.1/pricing-periods/bulkpost/api/v3.1/pricing-periods/bulk/{updateTaskUid}getProperties/api/v3.1/properties/{propertyUid}getPresumes a full update to the property resource. All fields need to be present.put/api/v3.1/properties/{propertyUid}deleteProvides ability to partially update property resource. Not all fields need to be presentpatch/api/v3.1/propertiesget/api/v3.1/propertiespostProperty Calendar/api/v3.1/property-calendar/{propertyUid}get/api/v3.1/property-calendargetProperty Channel Links/api/v3.1/property-channel-links/{uid}get/api/v3.1/property-channel-links/{uid}put/api/v3.1/property-channel-links/{uid}delete/api/v3.1/property-channel-linksget/api/v3.1/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.1/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.1/property-pricing-rules/{propertyUid}get/api/v3.1/property-pricing-rules/{propertyUid}putProperty Rules/api/v3.1/property-rules/{uid}get/api/v3.1/property-rules/{uid}put/api/v3.1/property-rules/{uid}delete/api/v3.1/property-rules/{uid}patch/api/v3.1/property-rulesget/api/v3.1/property-rulespostQuote/api/v3.1/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.1/reviews/{reviewUid}get/api/v3.1/reviews/{reviewUid}put/api/v3.1/reviews/{reviewUid}deleteGet the guest reviews for a property. One of 'propertyUid' or 'leadUid' request parameters is required.get/api/v3.1/reviewspostReviews-BulkCreate reviews in bulk. The max number of reviews allowed is 100postRooms/api/v3.1/rooms/{roomUid}get/api/v3.1/rooms/{roomUid}put/api/v3.1/rooms/{roomUid}delete/api/v3.1/roomsget/api/v3.1/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.1/service-providers/{serviceProviderUid}get/api/v3.1/service-providers/{serviceProviderUid}put/api/v3.1/service-providers/{serviceProviderUid}delete/api/v3.1/service-providersget/api/v3.1/service-providerspostServices/api/v3.1/services/{serviceUid}get/api/v3.1/services/{serviceUid}put/api/v3.1/servicesget/api/v3.1/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.getUnit types/api/v3.1/multi-units/unit-types/{unitTypeUid}get/api/v3.1/multi-units/unit-types/{unitTypeUid}deleteProvides ability to partially update unit type resource. Not all fields need to be presentpatch/api/v3.1/multi-units/unit-typesgetUnits/api/v3.1/multi-units/unitsget/api/v3.1/multi-units/units/{uid}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.1/webhookspost/api/v3.1/webhooks/{webhookUid}get/api/v3.1/webhooks/{webhookUid}deletegraph-ql-controller/api/v3.1/graphqlpostPowered by /api/v3.1/pin-codes/{pinCodeUid}put https://sandbox.hostfully.com/api/v3.1/pin-codes/{pinCodeUid}
