Close · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Close Users API

5 actions 5 updates phrasing extends openapi/close-users-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 5

$.info

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

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

$.paths['/user/availability/'].get

$.paths['/user/{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 Users API
  version: 1.0.0
extends: openapi/close-users-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: 4
- target: $.paths['/me/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get your own user profile
      effect: read
      questions:
      - How do I find my own user ID and organization ID?
      - Which account is my API key authenticated as?
      instructions:
      - text: Show my own user profile.
      - text: Get my user record with only {fields}.
        slots:
          fields: query._fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the organization
      effect: read
      questions:
      - Who are all the users in our organization?
      - Can I sort the team member list?
      instructions:
      - text: List all users in our organization.
      - text: List users ordered by {order_by}.
        slots:
          order_by: query._order_by
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/availability/'].get
  update:
    x-apievangelist-phrasing:
      intent: See who is available or on a call
      effect: read
      questions:
      - Which reps are on a call right now?
      - Can I check every user's availability status?
      instructions:
      - text: Show availability for all users.
      - text: List user availability for organization {organization_id}.
        slots:
          organization_id: query.organization_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single user
      effect: read
      questions:
      - How do I look up a teammate's details by user ID?
      - Where do I see one user's name and email?
      instructions:
      - text: Show user {id}.
        slots:
          id: path.id
      - text: Fetch the profile of user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'