# Hostfully Leads API

**Canonical:** https://apis.io/apis/hostfully/hostfully-leads-api/  
**Provider:** Hostfully — https://apis.io/providers/hostfully/  
**Base URL:** https://sandbox-api.hostfully.com  
**Documentation:** https://dev.hostfully.com/reference/getting-started

Hostfully Leads API is one of 53 APIs that [Hostfully](https://apis.io/providers/hostfully/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Leads. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

The Leads API from Hostfully — 17 operation(s) for leads.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v3.3/leads` | Search leads with filters |
| POST | `/api/v3.3/leads` | Create a new lead |
| GET | `/api/v3.3/leads/group-booking` | Get group-booking by 'groupUid' |
| GET | `/api/v3.3/leads/group-booking/{groupUid}` | Get group-booking by 'groupUid' |
| GET | `/api/v3.3/leads/{leadUid}` | Retrieve a lead by UID |
| DELETE | `/api/v3.3/leads/{leadUid}` | Delete obsolete lead |
| PATCH | `/api/v3.3/leads/{leadUid}` | Partially update lead information |
| POST | `/api/v3.3/leads/{leadUid}/accept-booking-request` | Accept booking request |
| POST | `/api/v3.3/leads/{leadUid}/alteration` | Alter lead details |
| POST | `/api/v3.3/leads/{leadUid}/cancel` | Cancel booking |
| POST | `/api/v3.3/leads/{leadUid}/close` | Close lead |
| POST | `/api/v3.3/leads/{leadUid}/decline-booking-request` | Decline booking request |
| POST | `/api/v3.3/leads/{leadUid}/extend-hold` | Extend hold duration |
| POST | `/api/v3.3/leads/{leadUid}/ignore` | Mark lead as ignored |
| POST | `/api/v3.3/leads/{leadUid}/mark-as-booked` | Transform inquiry to booking |
| POST | `/api/v3.3/leads/{leadUid}/mark-paf-completed` | Mark pre-arrival form completed |
| POST | `/api/v3.3/leads/{leadUid}/put-on-hold` | Place inquiry on hold |
| POST | `/api/v3.3/leads/{leadUid}/rebook` | Rebook cancelled booking |
| POST | `/api/v3.3/leads/{leadUid}/reopen` | Reopen inquiry |
| POST | `/api/v3.3/leads/{leadUid}/set-rental-conditions` | Update rental agreement URL |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/openapi/hostfully-leads-api-openapi.yml
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-amenity-adding-api3-dto-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-fee-saving-api3-3-dto-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-properties-creation-api3-dto-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-properties-patch-api3-dto-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-properties-saving-api3-dto-schema.json
- **JSONSchema** — https://raw.githubusercontent.com/api-evangelist/hostfully/refs/heads/main/json-schema/hostfully-unit-type-api3-1-update-request-dto-schema.json

## Other Hostfully APIs (12)

- [Hostfully REST API](https://apis.io/apis/hostfully/hostfully-rest-api/)
- [Hostfully GraphQL API](https://apis.io/apis/hostfully/hostfully-graphql-api/)
- [Hostfully Agencies API](https://apis.io/apis/hostfully/hostfully-agencies-api/)
- [Hostfully Amenities API](https://apis.io/apis/hostfully/hostfully-amenities-api/)
- [Hostfully Available Amenities API](https://apis.io/apis/hostfully/hostfully-available-amenities-api/)
- [Hostfully Available Property Rules API](https://apis.io/apis/hostfully/hostfully-available-property-rules-api/)
- [Hostfully Custom Amenities API](https://apis.io/apis/hostfully/hostfully-custom-amenities-api/)
- [Hostfully Custom Data API](https://apis.io/apis/hostfully/hostfully-custom-data-api/)
- [Hostfully Custom Data Fields API](https://apis.io/apis/hostfully/hostfully-custom-data-fields-api/)
- [Hostfully Direct Booking Site API](https://apis.io/apis/hostfully/hostfully-direct-booking-site-api/)
- [Hostfully Employees API](https://apis.io/apis/hostfully/hostfully-employees-api/)
- [Hostfully Extra Guests API](https://apis.io/apis/hostfully/hostfully-extra-guests-api/)

## Tags

Leads

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hostfully/hostfully-leads-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hostfully/.