Lusha · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lusha API Documentation Prospecting API

3 actions 3 updates phrasing extends openapi/lusha-prospecting-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Lusha's API. It is a proposal applied on top of the contract, not a document Lusha publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v3/contacts/prospecting'].post

$.paths['/v3/companies/prospecting'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lusha API Documentation Prospecting API
  version: 1.0.0
extends: openapi/lusha-prospecting-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v3/contacts/prospecting'].post
  update:
    x-apievangelist-phrasing:
      intent: Find contacts matching my ideal customer profile
      effect: read
      questions:
      - How do I find VPs of sales in the US at mid-size software companies?
      - Can I prospect only for contacts that have a phone number on file?
      - Can prospecting results for people be saved to a table?
      instructions:
      - text: Find contacts matching filters {filters}, page {pagination}.
        slots:
          filters: requestBody.filters
          pagination: requestBody.pagination
      - text: Prospect people using {filters} with paging {pagination} and add them to table {tableId}.
        slots:
          filters: requestBody.filters
          pagination: requestBody.pagination
          tableId: requestBody.tableId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/companies/prospecting'].post
  update:
    x-apievangelist-phrasing:
      intent: Find companies matching my target market
      effect: read
      questions:
      - How do I find companies of a certain size and industry that use a given technology?
      - Can I prospect companies by buyer intent topic?
      - Can I filter target companies by SIC or NAICS code?
      instructions:
      - text: Find companies matching filters {filters}, page {pagination}.
        slots:
          filters: requestBody.filters
          pagination: requestBody.pagination
      - text: Prospect accounts using {filters} with paging {pagination} and save them to table {tableId}.
        slots:
          filters: requestBody.filters
          pagination: requestBody.pagination
          tableId: requestBody.tableId
      method: generated
      generated: '2026-09-26'