ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Data API V1 Search API

6 actions 6 updates phrasing extends openapi/zoominfo-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 6

$.info
$.paths['/data/v1/contacts/search'].post
$.paths['/data/v1/companies/search'].post
$.paths['/data/v1/intent/search'].post
$.paths['/data/v1/news/search'].post
$.paths['/data/v1/scoops/search'].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 Data API V1 Search API
  version: 1.0.0
extends: openapi/zoominfo-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: 5
- target: $.paths['/data/v1/contacts/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search for contacts
      effect: read
      questions:
      - How do I find people by job title, seniority and location?
      - Can I page through contact search results sorted by a field?
      instructions:
      - text: Search for contacts matching {criteria}.
        slots:
          criteria: requestBody.data
      - text: Find people matching {criteria} and show page {page}.
        slots:
          criteria: requestBody.data
          page: query.page[number]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/companies/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search for companies
      effect: read
      questions:
      - How do I find companies by industry, revenue and headcount?
      - Can I sort company search results by a field like revenue?
      instructions:
      - text: Search for companies matching {criteria}.
        slots:
          criteria: requestBody.data
      - text: Find companies matching {criteria} sorted by {sort}.
        slots:
          criteria: requestBody.data
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/intent/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search intent signals by topic
      effect: read
      questions:
      - Which companies are showing intent on the topics I care about?
      - How many intent topics can I include in one search?
      instructions:
      - text: Search intent signals for topics {criteria}.
        slots:
          criteria: requestBody.data
      - text: Find in-market companies researching {criteria}.
        slots:
          criteria: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/news/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search news articles
      effect: read
      questions:
      - Can I search news articles across all companies by category?
      - What's the minimum I need to set to run a news search?
      instructions:
      - text: Search news articles matching {criteria}.
        slots:
          criteria: requestBody.data
      - text: Find news articles for {criteria} and show {size} per page.
        slots:
          criteria: requestBody.data
          size: query.page[size]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/scoops/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search scoops
      effect: read
      questions:
      - Which companies have recent scoops like new funding or executive hires?
      - Can I search scoops across many companies at once?
      instructions:
      - text: Search scoops matching {criteria}.
        slots:
          criteria: requestBody.data
      - text: Find scoops about {criteria} sorted by {sort}.
        slots:
          criteria: requestBody.data
          sort: query.sort
      method: generated
      generated: '2026-09-26'