HeySale

HeySale API

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

GitHub OpenAPI

Operations 9

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. #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hey-sale/openapi/_ae-authored/hey-sale-openapi-generated.yml

Schemas & Data

📊
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

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/hey-sale:hey-sale-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hey-sale-openapi-generated.yml Raw ↑ 
openapi: 3.1.0
info:
  title: HeySale API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 9 operation(s) read from 2 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; HeySale has published no machine-readable contract that the pipeline
    could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 8
    pages-with-code: 2
    pages-read: 2
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://hey.sale/developers
  - https://hey.sale/developers/lovable
paths:
  /api/public/integrations.json:
    get:
      operationId: get_api_public_integrations_json
      tags:
      - Api
      summary: Machine-readable registry of supported platforms, install methods and MCP details.
      description: Provides a JSON registry of integrations. No authentication required.
      x-source: https://hey.sale/developers
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicIntegrationsJsonResponse'
      x-evidence:
        kind: documentation
  /api/public/v1/integrations/salespeople:
    patch:
      operationId: patch_api_public_v1_integrations_salespeople
      tags:
      - Api
      summary: Update name, greeting or domain.
      x-source: https://hey.sale/developers/lovable
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_public_v1_integrations_salespeople
      tags:
      - Api
      summary: POST /api/public/v1/integrations/salespeople
      x-source: https://hey.sale/developers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiPublicV1IntegrationsSalespeopleRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl) curl -X POST https://hey.sale/api/public/v1/integrations/salespeople  -H "content-type: application/json"  -H "idempotency-key:
          your-unique-key"  -d ''{"website_url":"https://example.com","integration_source":"api"}'' Copy Export leads (curl) curl https://hey.sale/api/public/v1/leads?limit=25  -H
          "authorization: Bearer YOUR_API_KEY" Copy Common errors Code HTTP Meaning invalid_url 400 The webs'
  /api/public/v1/integrations/salespeople/{id}:
    get:
      operationId: get_api_public_v1_integrations_salespeople_id
      tags:
      - Api
      summary: Build status for a salesperson.
      description: Retrieve the provisioning status of a salesperson. No authentication required.
      x-source: https://hey.sale/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicV1IntegrationsSalespeopleIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_public_v1_integrations_salespeople_id
      tags:
      - Api
      summary: Update name, greeting or objective.
      description: Modify configuration of an existing salesperson. Requires the salesperson's API key.
      x-source: https://hey.sale/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key for the salesperson.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiPublicV1IntegrationsSalespeopleIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchApiPublicV1IntegrationsSalespeopleIdResponse'
      x-evidence:
        kind: documentation
  /api/public/v1/integrations/salespeople/{id}/installation:
    get:
      operationId: get_api_public_v1_integrations_salespeople_id_installation
      tags:
      - Api
      summary: The embed script, its placement, and whether it has been detected on the site.
      description: Retrieve installation details for a salesperson. No authentication required.
      x-source: https://hey.sale/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicV1IntegrationsSalespeopleIdInstallationResponse'
      x-evidence:
        kind: documentation
  /api/public/v1/integrations/salespeople/{id}/results:
    get:
      operationId: get_api_public_v1_integrations_salespeople_id_results
      tags:
      - Api
      summary: Conversation, lead and usage summary.
      description: Get summarized results for a salesperson over an optional period. Requires API key.
      x-source: https://hey.sale/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: days
        in: query
        required: false
        schema:
          type: integer
        description: Number of days to summarize (1..90).
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key for the salesperson.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicV1IntegrationsSalespeopleIdResultsResponse'
      x-evidence:
        kind: documentation
  /api/public/v1/leads:
    get:
      operationId: get_api_public_v1_leads
      tags:
      - Api
      summary: Paged lead export.
      description: Export leads with optional filters. Requires API key.
      x-source: https://hey.sale/developers
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Maximum number of leads to return (1-100).
      - name: since
        in: query
        required: false
        schema:
          type: string
        description: ISO date to filter leads created since.
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by lead status.
      - name: include_transcript
        in: query
        required: false
        schema:
          type: boolean
        description: Whether to include conversation transcripts.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicV1LeadsResponse'
      x-evidence:
        kind: documentation
  /api/public/v1/leads/{id}:
    get:
      operationId: get_api_public_v1_leads_id
      tags:
      - Api
      summary: A single lead, optionally with its transcript.
      description: Retrieve a specific lead. Requires API key.
      x-source: https://hey.sale/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include_transcript
        in: query
        required: false
        schema:
          type: boolean
        description: Whether to include the transcript.
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
        description: Bearer API key.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiPublicV1LeadsIdResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetApiPublicIntegrationsJsonResponse:
      type: object
      properties:
        integrations:
          type: array
          description: List of integration definitions.
    PostApiPublicV1IntegrationsSalespeopleRequest:
      type: object
      properties:
        website_url:
          type: string
        integration_source:
          type: string
    GetApiPublicV1IntegrationsSalespeopleIdResponse:
      type: object
      properties:
        status:
          type: string
          description: Current build status of the salesperson.
    PatchApiPublicV1IntegrationsSalespeopleIdRequest:
      type: object
      properties:
        name:
          type: string
          description: New name for the salesperson.
        greeting:
          type: string
          description: New greeting line.
        objective:
          type: string
          description: New conversation objective.
    PatchApiPublicV1IntegrationsSalespeopleIdResponse:
      type: object
      properties:
        ok:
          type: boolean
          description: Indicates success.
    GetApiPublicV1IntegrationsSalespeopleIdInstallationResponse:
      type: object
      properties:
        install_script:
          type: string
          description: The embed script to add to the site.
        placement:
          type: string
          description: Where the script should be placed.
        detected:
          type: boolean
          description: Whether the script has been detected on the live site.
    GetApiPublicV1IntegrationsSalespeopleIdResultsResponse:
      type: object
      properties:
        conversations:
          type: integer
          description: Total number of conversations.
        leads:
          type: integer
          description: Total number of leads captured.
        minutes_used:
          type: integer
          description: Total conversation minutes used.
    GetApiPublicV1LeadsResponse:
      type: object
      properties:
        leads:
          type: array
          description: Array of lead objects.
        next_page_token:
          type: string
          description: Token for pagination.
    GetApiPublicV1LeadsIdResponse:
      type: object
      properties:
        id:
          type: string
          description: Lead ID.
        name:
          type: string
          description: Lead name.
        email:
          type: string
          description: Lead email.
        company:
          type: string
          description: Lead company.
        transcript:
          type: string
          description: Conversation transcript if requested.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Api