Coresignal · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Coresignal Multi-source Company Collect API

3 actions 3 updates phrasing extends openapi/coresignal-collect-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/collect/{id}'].get

$.paths['/bulk_collect'].post

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 Coresignal Multi-source Company Collect API
  version: 1.0.0
extends: openapi/coresignal-collect-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: 2
- target: $.paths['/collect/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the full record for one company
      effect: read
      questions:
      - How do I pull the complete enriched profile for a single company once I have its Coresignal ID?
      - What fields come back when I fetch one company record by its ID?
      - Can I look up just one company's full data without sending a list of IDs?
      instructions:
      - text: Fetch the full company record for ID {id}.
        slots:
          id: path.id
      - text: Get every enriched field for company {id} so I can review its profile.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/bulk_collect'].post
  update:
    x-apievangelist-phrasing:
      intent: Get full records for many companies at once
      effect: read
      questions:
      - Can I retrieve full records for a whole batch of company IDs in one request?
      - What's the way to download complete profiles for every company ID my search returned?
      instructions:
      - text: Bulk collect the full company records for IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: 'Pull complete profiles for this list of company IDs in a single batch: {ids}.'
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'