G2 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for G2 Activate API

6 actions 6 updates phrasing extends openapi/g2-g2-activate-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for G2's API. It is a proposal applied on top of the contract, not a document G2 publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/api/v2/products/{product_id}/g2_activate/industry_search'].post

$.paths['/api/v2/products/{product_id}/g2_activate/locked_companies'].get

$.paths['/api/v2/products/{product_id}/g2_activate/unlocked_companies'].get

$.paths['/api/v2/products/{product_id}/g2_activate/unlocked_companies'].post

$.paths['/api/v2/products/{product_id}/g2_activate/unlocked_companies/{id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for G2 Activate API
  version: 1.0.0
extends: openapi/g2-g2-activate-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/api/v2/products/{product_id}/g2_activate/industry_search'].post
  update:
    x-apievangelist-phrasing:
      intent: Match a business description to NAICS industries
      effect: read
      questions:
      - Which NAICS industry names fit a free-text description of a business?
      - Can I turn a plain description of my target customers into industry names?
      - How many industry matches can I get back for one description?
      instructions:
      - text: Match {query} to NAICS industries for product {product_id}.
        slots:
          query: requestBody.query
          product_id: path.product_id
      - text: Find the top {limit} industry names for {query} on {product_id}.
        slots:
          limit: requestBody.limit
          query: requestBody.query
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/products/{product_id}/g2_activate/locked_companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List masked companies showing intent
      effect: read
      questions:
      - Which anonymous companies are showing intent for my product that I haven't unlocked yet?
      - Can I preview locked, masked intent accounts before spending credits?
      instructions:
      - text: List locked intent companies for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show masked companies for {product_id} sorted by {sort}.
        slots:
          product_id: path.product_id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/products/{product_id}/g2_activate/unlocked_companies'].get
  update:
    x-apievangelist-phrasing:
      intent: List companies I've already unlocked
      effect: read
      questions:
      - Which intent companies have I already revealed for my product?
      - Can I review every company we've paid credits to unlock?
      instructions:
      - text: List unlocked companies for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show unlocked companies for {product_id} sorted by {sort}.
        slots:
          product_id: path.product_id
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/products/{product_id}/g2_activate/unlocked_companies'].post
  update:
    x-apievangelist-phrasing:
      intent: Spend credits to unlock masked companies
      effect: write
      questions:
      - How do I reveal the identity of masked companies showing intent?
      - How many locked companies can I unlock with credits in one request?
      - Does re-unlocking a company I've already revealed cost credits again?
      instructions:
      - text: Unlock companies {sigs} for product {product_id}.
        slots:
          sigs: requestBody.sigs
          product_id: path.product_id
      - text: Spend credits to reveal the locked companies {sigs} on {product_id}.
        slots:
          sigs: requestBody.sigs
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/products/{product_id}/g2_activate/unlocked_companies/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an unlocked company and its contacts
      effect: read
      questions:
      - Who are the contacts at a company I unlocked?
      - Can I see the full record for one revealed intent company?
      instructions:
      - text: Show unlocked company {id} for product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      - text: Get contacts for unlocked company {id} on {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'