Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Exports API

9 actions 9 updates phrasing extends openapi/close-exports-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info

$.paths['/export/'].get

$.paths['/export/lead/'].get

$.paths['/export/lead/'].post

$.paths['/export/lead/{id}/'].get

$.paths['/export/opportunity/'].get

$.paths['/export/opportunity/'].post

$.paths['/export/opportunity/{id}/'].get

$.paths['/export/{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 Close Exports API
  version: 1.0.0
extends: openapi/close-exports-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: 8
- target: $.paths['/export/'].get
  update:
    x-apievangelist-phrasing:
      intent: List all data exports
      effect: read
      questions:
      - Which exports has my organization run, of any kind?
      - Can I page through every export regardless of whether it was leads or opportunities?
      instructions:
      - text: List all exports.
      - text: Show the first {limit} exports of any type.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/lead/'].get
  update:
    x-apievangelist-phrasing:
      intent: List lead exports
      effect: read
      questions:
      - What lead exports have been run recently?
      - Can I see only the exports that were for leads?
      instructions:
      - text: List my lead exports.
      - text: Show {limit} lead exports, skipping the first {skip}.
        slots:
          limit: query._limit
          skip: query._skip
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/lead/'].post
  update:
    x-apievangelist-phrasing:
      intent: Export leads matching a search
      effect: write
      questions:
      - How do I export leads that match a search query to a file?
      - Is the lead export file compressed, and how do I get it?
      instructions:
      - text: Export all leads matching my search query and email me the file.
      - text: Start a lead export for my current lead search.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/lead/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a lead export's status
      effect: read
      questions:
      - Is my lead export finished yet?
      - Where do I get the download URL for a completed lead export?
      instructions:
      - text: Check the status of lead export {id}.
        slots:
          id: path.id
      - text: Get the download link for lead export {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/opportunity/'].get
  update:
    x-apievangelist-phrasing:
      intent: List opportunity exports
      effect: read
      questions:
      - Which opportunity exports have been generated?
      - Can I list just the exports of opportunities?
      instructions:
      - text: List my opportunity exports.
      - text: Show {limit} opportunity exports.
        slots:
          limit: query._limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/opportunity/'].post
  update:
    x-apievangelist-phrasing:
      intent: Export opportunities by filter
      effect: write
      questions:
      - Can I export opportunities as CSV or JSON using opportunity filters?
      - How do I export only the opportunities that match certain filters?
      instructions:
      - text: Export all opportunities to a CSV file.
      - text: Start an opportunity export as JSON filtered to my open deals.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/opportunity/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an opportunity export's status
      effect: read
      questions:
      - Has my opportunity export finished processing?
      - Where's the download URL for an opportunity export?
      instructions:
      - text: Check the status of opportunity export {id}.
        slots:
          id: path.id
      - text: Get the download link for opportunity export {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/export/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get any export by id
      effect: read
      questions:
      - What status is a given export in, whatever its type?
      - Can I look up an export by id without knowing if it was leads or opportunities?
      instructions:
      - text: Fetch export {id} and tell me its status.
        slots:
          id: path.id
      - text: Look up generic export {id} and give me its download URL if done.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'