# HeySale API

**Canonical:** https://apis.io/apis/hey-sale/hey-sale-api/  
**Provider:** HeySale — https://apis.io/providers/hey-sale/  
**Documentation:** https://hey.sale/developers

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

HeySale API as documented publicly: 9 operations. Contract generated from the documentation by API Evangelist (2026-11-11); not the provider's own document.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/public/integrations.json` | Machine-readable registry of supported platforms, install methods and MCP details. |
| PATCH | `/api/public/v1/integrations/salespeople` | Update name, greeting or domain. |
| POST | `/api/public/v1/integrations/salespeople` | POST /api/public/v1/integrations/salespeople |
| GET | `/api/public/v1/integrations/salespeople/{id}` | Build status for a salesperson. |
| PATCH | `/api/public/v1/integrations/salespeople/{id}` | Update name, greeting or objective. |
| GET | `/api/public/v1/integrations/salespeople/{id}/installation` | The embed script, its placement, and whether it has been detected on the site. |
| GET | `/api/public/v1/integrations/salespeople/{id}/results` | Conversation, lead and usage summary. |
| GET | `/api/public/v1/leads` | Paged lead export. |
| GET | `/api/public/v1/leads/{id}` | A single lead, optionally with its transcript. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/hey-sale/openapi/_ae-authored/hey-sale-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/hey-sale/json-schema/hey-sale-get-api-public-v1-leads-id-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hey-sale/json-schema/hey-sale-get-api-public-v1-integrations-salespeople-id-installation-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hey-sale/json-schema/hey-sale-get-api-public-v1-integrations-salespeople-id-results-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hey-sale/json-schema/hey-sale-patch-api-public-v1-integrations-salespeople-id-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/hey-sale/json-schema/hey-sale-get-api-public-v1-leads-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/hey-sale/json-schema/hey-sale-get-api-public-v1-integrations-salespeople-id-response-schema.json

## Other HeySale APIs (1)

- [HeySale API](https://apis.io/apis/hey-sale/heysale-api/)

---

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