Lusha · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Lusha API Documentation Prospecting - Search & Enrich API

5 actions 5 updates phrasing extends openapi/lusha-prospecting-search-enrich-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 5

$.info
$.paths['/prospecting/contact/search'].post
$.paths['/prospecting/contact/enrich'].post
$.paths['/prospecting/company/search'].post
$.paths['/prospecting/company/enrich'].post

OpenAPI Overlay

Raw ↑
# 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 - Search & Enrich API
  version: 1.0.0
extends: openapi/lusha-prospecting-search-enrich-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: 4
- target: $.paths['/prospecting/contact/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contacts by prospecting filters
      effect: read
      questions:
      - How do I search for contacts with filters in the older prospecting flow?
      - Can I leave do-not-call contacts out of prospecting search results?
      - Can I filter prospecting contacts by signals like a recent promotion?
      instructions:
      - text: Search prospecting contacts with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Search contacts with {filters}, excluding do-not-call, pages {pages}.
        slots:
          filters: requestBody.filters
          pages: requestBody.pages
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prospecting/contact/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich contacts from a prospecting search
      effect: write
      questions:
      - How do I reveal emails for contacts returned by a prospecting search?
      - What do I need from the search step to enrich prospected contacts?
      instructions:
      - text: Enrich contacts {contactIds} from prospecting search {requestId}.
        slots:
          contactIds: requestBody.contactIds
          requestId: requestBody.requestId
      - text: Reveal phones only for contacts {contactIds} from search request {requestId}.
        slots:
          contactIds: requestBody.contactIds
          requestId: requestBody.requestId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prospecting/company/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search companies by prospecting filters
      effect: read
      questions:
      - Which accounts match my industry and size filters in step two of prospecting?
      - Can I filter prospecting companies by signals such as hiring surges?
      instructions:
      - text: Search prospecting companies with filters {filters}.
        slots:
          filters: requestBody.filters
      - text: Search companies with {filters} and return pages {pages}.
        slots:
          filters: requestBody.filters
          pages: requestBody.pages
      method: generated
      generated: '2026-09-26'
- target: $.paths['/prospecting/company/enrich'].post
  update:
    x-apievangelist-phrasing:
      intent: Enrich companies from a prospecting search
      effect: write
      questions:
      - How do I get full details for companies returned by a prospecting search?
      - Which request ID do I pass to enrich prospected companies?
      instructions:
      - text: Enrich companies {companiesIds} from prospecting search {requestId}.
        slots:
          companiesIds: requestBody.companiesIds
          requestId: requestBody.requestId
      - text: Reveal company data for {companiesIds} found in search request {requestId}.
        slots:
          companiesIds: requestBody.companiesIds
          requestId: requestBody.requestId
      method: generated
      generated: '2026-09-26'