ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZoomInfo Contact Search API

4 actions 4 updates phrasing extends openapi/zoominfo-contact-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for ZoomInfo's API. It is a proposal applied on top of the contract, not a document ZoomInfo publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/search/contact'].post
$.paths['/lookup/inputfields/contact/search'].get
$.paths['/lookup/outputfields/contact/search'].get

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 ZoomInfo Contact Search API
  version: 1.0.0
extends: openapi/zoominfo-contact-search-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: 3
- target: $.paths['/search/contact'].post
  update:
    x-apievangelist-phrasing:
      intent: Search for contacts by criteria
      effect: read
      questions:
      - How do I find VP-level contacts within a radius of a zip code?
      - Can I search for people at companies that use a specific technology?
      instructions:
      - text: Find {level} contacts within {miles} miles of {zip}.
        slots:
          level: requestBody.managementLevel
          miles: requestBody.zipCodeRadiusMiles
          zip: requestBody.zipCode
      - text: Search for contacts at {companyType} companies using {tech}.
        slots:
          companyType: requestBody.companyType
          tech: requestBody.techAttributeTagList
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/inputfields/contact/search'].get
  update:
    x-apievangelist-phrasing:
      intent: List search criteria for contact search
      effect: read
      questions:
      - Which filters can I use when searching for people?
      - What criteria does contact search accept, like job title or management level?
      instructions:
      - text: List the search criteria available for contact search.
      - text: Show the input fields I can filter contacts by.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/outputfields/contact/search'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields returned by contact search
      effect: read
      questions:
      - What fields come back for each person in contact search results?
      - Can I see the response columns of a contact search?
      instructions:
      - text: List the fields contact search results include.
      - text: Show which attributes each contact search hit contains.
      method: generated
      generated: '2026-09-26'