# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoominfo Lookup API
  version: 1.0.0
extends: openapi/zoominfo-lookup-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: 35
- target: $.paths['/data/v1/lookup/{fieldName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get allowed values for a lookup field
      effect: read
      questions:
      - What values can I use for a field like company rankings in the newer data API?
      - Can I narrow hashtag or tech lookup values by category or vendor?
      instructions:
      - text: Get lookup values for field {fieldName}.
        slots:
          fieldName: path.fieldName
      - text: Show {fieldName} values in parent category {parent}.
        slots:
          fieldName: path.fieldName
          parent: query.filter[parentCategory]
      - text: List {fieldName} lookup values from vendor {vendor}.
        slots:
          fieldName: path.fieldName
          vendor: query.filter[vendor]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/lookup/search'].get
  update:
    x-apievangelist-phrasing:
      intent: List searchable fields for an entity
      effect: read
      questions:
      - Which fields can I filter on when searching contacts or companies?
      - What search fields exist for a given entity and field type?
      instructions:
      - text: List search fields for entity {entity} of type {fieldType}.
        slots:
          entity: query.filter[entity]
          fieldType: query.filter[fieldType]
      - text: Show the searchable {fieldType} fields on {entity}.
        slots:
          fieldType: query.filter[fieldType]
          entity: query.filter[entity]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/data/v1/lookup/enrich'].get
  update:
    x-apievangelist-phrasing:
      intent: List enrichable fields for an entity
      effect: read
      questions:
      - Which fields can enrichment return for contacts or companies?
      - What enrich fields exist for a given entity and field type?
      instructions:
      - text: List enrich fields for entity {entity} of type {fieldType}.
        slots:
          entity: query.filter[entity]
          fieldType: query.filter[fieldType]
      - text: Show the {fieldType} fields I can enrich on {entity}.
        slots:
          fieldType: query.filter[fieldType]
          entity: query.filter[entity]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/companyranking'].get
  update:
    x-apievangelist-phrasing:
      intent: List company ranking values
      effect: read
      questions:
      - Which company rankings, like Fortune 500, can I filter by?
      - What ranking lists does ZoomInfo accept as search input?
      instructions:
      - text: List the accepted company ranking values.
      - text: Show me the ranking lists I can filter companies on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/continent'].get
  update:
    x-apievangelist-phrasing:
      intent: List continent values
      effect: read
      questions:
      - What continent names does search accept?
      - Which continents can I filter companies by?
      instructions:
      - text: List the accepted continents.
      - text: Show continent filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/country'].get
  update:
    x-apievangelist-phrasing:
      intent: List country values
      effect: read
      questions:
      - What country names are valid in a search?
      - Which countries can I filter contacts or companies by?
      instructions:
      - text: List the accepted countries.
      - text: Show every country filter value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/state'].get
  update:
    x-apievangelist-phrasing:
      intent: List state values
      effect: read
      questions:
      - Which state or province values can I use as a location filter?
      - What's the accepted spelling for US states in search?
      instructions:
      - text: List the accepted states.
      - text: Show state filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/department'].get
  update:
    x-apievangelist-phrasing:
      intent: List contact department values
      effect: read
      questions:
      - Which departments can I filter contacts by, like Sales or Finance?
      - What department names does a contact search accept?
      instructions:
      - text: List the accepted contact departments.
      - text: Show department values for people searches.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/employeecount'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee count ranges
      effect: read
      questions:
      - What headcount ranges can I filter companies by?
      - Which employee count buckets does search accept?
      instructions:
      - text: List the accepted employee count ranges.
      - text: Show company size filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/siccode'].get
  update:
    x-apievangelist-phrasing:
      intent: List SIC industry codes
      effect: read
      questions:
      - Which SIC codes are valid for filtering companies?
      - Can I get the full list of Standard Industrial Classification codes?
      instructions:
      - text: List the accepted SIC codes.
      - text: Show every SIC industry code I can search with.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/naicscode'].get
  update:
    x-apievangelist-phrasing:
      intent: List NAICS industry codes
      effect: read
      questions:
      - Which NAICS codes are valid for filtering companies?
      - Can I get the full list of North American Industry Classification codes?
      instructions:
      - text: List the accepted NAICS codes.
      - text: Show every NAICS code I can search with.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/industry'].get
  update:
    x-apievangelist-phrasing:
      intent: List ZoomInfo industry codes
      effect: read
      questions:
      - What industry categories does ZoomInfo use in search?
      - Which industry code values can I pass to filter companies?
      instructions:
      - text: List the accepted industry codes.
      - text: Show ZoomInfo's industry categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/jobtitlehierarchy'].get
  update:
    x-apievangelist-phrasing:
      intent: List job title hierarchy values
      effect: read
      questions:
      - How are job titles grouped into a hierarchy for searching?
      - Which job title hierarchy values can I filter people by?
      instructions:
      - text: List the job title hierarchy values.
      - text: Show the title hierarchy used for contact searches.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/jobfunction'].get
  update:
    x-apievangelist-phrasing:
      intent: List job function values
      effect: read
      questions:
      - Which job functions can I target, like marketing operations?
      - What job function values does contact search accept?
      instructions:
      - text: List the accepted job functions.
      - text: Show job function filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/metroarea'].get
  update:
    x-apievangelist-phrasing:
      intent: List metro area values
      effect: read
      questions:
      - Which metro areas can I use as a location filter?
      - What's the accepted name for a metro region in search?
      instructions:
      - text: List the accepted metro areas.
      - text: Show metro region filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/revenuerange'].get
  update:
    x-apievangelist-phrasing:
      intent: List revenue range values
      effect: read
      questions:
      - What revenue ranges can I filter companies by?
      - Which annual revenue buckets does search accept?
      instructions:
      - text: List the accepted revenue ranges.
      - text: Show company revenue filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/scooptopic'].get
  update:
    x-apievangelist-phrasing:
      intent: List scoop topic values
      effect: read
      questions:
      - What topics can scoops be filtered by?
      - Which scoop topic values are accepted?
      instructions:
      - text: List the accepted scoop topics.
      - text: Show every scoop topic filter value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/scooptype'].get
  update:
    x-apievangelist-phrasing:
      intent: List scoop type values
      effect: read
      questions:
      - What kinds of scoops exist, like funding or new hires?
      - Which scoop type values can I pass to a scoop search?
      instructions:
      - text: List the accepted scoop types.
      - text: Show the scoop categories I can filter on.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/scoopdepartment'].get
  update:
    x-apievangelist-phrasing:
      intent: List scoop department values
      effect: read
      questions:
      - Which departments can scoops be tied to?
      - What department values does a scoop search accept?
      instructions:
      - text: List the accepted scoop departments.
      - text: Show department values used for scoops.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/companytype'].get
  update:
    x-apievangelist-phrasing:
      intent: List company type values
      effect: read
      questions:
      - Can I filter by public, private or nonprofit companies?
      - Which company type values are accepted?
      instructions:
      - text: List the accepted company types.
      - text: Show ownership type filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/boardMember'].get
  update:
    x-apievangelist-phrasing:
      intent: List board member filter values
      effect: read
      questions:
      - What board member options can I filter contacts by?
      - Which board member values does search accept?
      instructions:
      - text: List the accepted board member values.
      - text: Show board membership filter options.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/managementLevel'].get
  update:
    x-apievangelist-phrasing:
      intent: List management level values
      effect: read
      questions:
      - Which seniority levels can I target, like C-level or director?
      - What management level values does contact search accept?
      instructions:
      - text: List the accepted management levels.
      - text: Show seniority filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/subunittypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List sub-unit type values
      effect: read
      questions:
      - What kinds of company sub-units, like divisions or branches, are there?
      - Which sub-unit type values are accepted?
      instructions:
      - text: List the accepted sub-unit types.
      - text: Show company sub-unit type values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/tech/category'].get
  update:
    x-apievangelist-phrasing:
      intent: List technology categories
      effect: read
      questions:
      - Which technology categories can I filter companies by?
      - What tech category names does ZoomInfo recognize?
      instructions:
      - text: List the accepted technology categories.
      - text: Show every tech category filter value.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/tech/vendor'].get
  update:
    x-apievangelist-phrasing:
      intent: List technology vendors
      effect: read
      questions:
      - Which technology vendors can I search for in a company's stack?
      - What vendor names are valid in a tech filter?
      instructions:
      - text: List the accepted technology vendors.
      - text: Show tech vendor filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/tech/product'].get
  update:
    x-apievangelist-phrasing:
      intent: List technology products for a vendor
      effect: read
      questions:
      - Which products from a given software vendor can I filter by?
      - Can I list tech products within one category and vendor?
      instructions:
      - text: List tech products from vendor {vendor} in category {category}.
        slots:
          vendor: query.vendor
          category: query.category
      - text: Show {vendor} products under parent category {parent}.
        slots:
          vendor: query.vendor
          parent: query.parentCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/tech-skills'].get
  update:
    x-apievangelist-phrasing:
      intent: List tech skill values
      effect: read
      questions:
      - What technical skills can I filter people by?
      - Which tech skill values does ZoomInfo track?
      instructions:
      - text: List the tech skill values.
      - text: Show accepted technical skills for contacts.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/hashtag'].get
  update:
    x-apievangelist-phrasing:
      intent: List hashtag values by category
      effect: read
      questions:
      - Which hashtags exist within a given category or vendor?
      - Can I browse hashtag values under a parent category?
      instructions:
      - text: List hashtags in category {category} for vendor {vendor}.
        slots:
          category: query.category
          vendor: query.vendor
      - text: Show hashtag values under parent category {parent}.
        slots:
          parent: query.parentCategory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/intent/topics'].get
  update:
    x-apievangelist-phrasing:
      intent: List intent topics and categories
      effect: read
      questions:
      - Which intent topics can I track buyer interest on?
      - What categories are intent topics grouped into?
      instructions:
      - text: List the accepted intent topics.
      - text: Show intent topic categories.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/news/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List news categories
      effect: read
      questions:
      - What news categories can I filter articles by?
      - Which news category values are accepted?
      instructions:
      - text: List the accepted news categories.
      - text: Show news category filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/employee-category-band'].get
  update:
    x-apievangelist-phrasing:
      intent: List employee category bands
      effect: read
      questions:
      - What employee size bands does ZoomInfo group companies into?
      - Which employee category band values exist?
      instructions:
      - text: List the employee category bands.
      - text: Show headcount band values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/revenue-category-band'].get
  update:
    x-apievangelist-phrasing:
      intent: List revenue category bands
      effect: read
      questions:
      - What revenue bands does ZoomInfo group companies into?
      - Which revenue category band values exist?
      instructions:
      - text: List the revenue category bands.
      - text: Show revenue band values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/years-of-experience'].get
  update:
    x-apievangelist-phrasing:
      intent: List years-of-experience ranges
      effect: read
      questions:
      - What experience ranges can I filter contacts by?
      - Which years-of-experience values are accepted?
      instructions:
      - text: List the accepted years-of-experience ranges.
      - text: Show experience filter values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/hierarchy-code'].get
  update:
    x-apievangelist-phrasing:
      intent: List company hierarchy codes
      effect: read
      questions:
      - What hierarchy codes describe a company's position, like parent or subsidiary?
      - Which company hierarchy code values exist?
      instructions:
      - text: List the company hierarchy codes.
      - text: Show hierarchy code values.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/lookup/buyinggroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List buying groups
      effect: read
      questions:
      - What buying groups does ZoomInfo define?
      - Can I see the buying group information available?
      instructions:
      - text: List the buying groups.
      - text: Show buying group details.
      method: generated
      generated: '2026-09-26'