ZoomInfo · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ZoomInfo Scoop Search API

4 actions 4 updates phrasing extends openapi/zoominfo-scoop-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/scoop'].post
$.paths['/lookup/inputfields/scoop/search'].get
$.paths['/lookup/outputfields/scoop/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 Scoop Search API
  version: 1.0.0
extends: openapi/zoominfo-scoop-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/scoop'].post
  update:
    x-apievangelist-phrasing:
      intent: Search scoops across companies
      effect: read
      questions:
      - How do I find scoops by type across many companies?
      - Can I search scoops by keywords in their description?
      instructions:
      - text: Search scoops of type {scoopType} published after {start}.
        slots:
          scoopType: requestBody.scoopType
          start: requestBody.publishedStartDate
      - text: Find scoops mentioning {text}.
        slots:
          text: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/inputfields/scoop/search'].get
  update:
    x-apievangelist-phrasing:
      intent: List search criteria for scoop search
      effect: read
      questions:
      - Which filters can I use to search scoops across companies?
      - What inputs does scoop search accept?
      instructions:
      - text: List the search criteria for scoop search.
      - text: Show the input fields I can filter scoops by.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/outputfields/scoop/search'].get
  update:
    x-apievangelist-phrasing:
      intent: List fields returned by scoop search
      effect: read
      questions:
      - What fields come back for each scoop in search results?
      - Can I see the response columns of a scoop search?
      instructions:
      - text: List the fields scoop search results include.
      - text: Show which attributes each scoop search hit contains.
      method: generated
      generated: '2026-09-26'