Leadspace · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Leadspace Enrichment API v4 Authorization API

3 actions 3 updates phrasing extends openapi/leadspace-authorization-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Leadspace's API. It is a proposal applied on top of the contract, not a document Leadspace publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/oauth/authorize'].put
$.paths['/oauth/authorize'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Leadspace Enrichment API v4 Authorization API
  version: 1.0.0
extends: openapi/leadspace-authorization-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['/oauth/authorize'].put
  update:
    x-apievangelist-phrasing:
      intent: Refresh an expired access token
      effect: write
      questions:
      - Can I renew my bearer token with a refresh token instead of sending my secret again?
      - What do I send to swap a refresh token for a new access token?
      instructions:
      - text: Refresh the access token for program ID {user} using refresh token {refreshToken}.
        slots:
          user: requestBody.user
          refreshToken: requestBody.refreshToken
      - text: Exchange refresh token {refreshToken} for a new bearer token for {user}.
        slots:
          refreshToken: requestBody.refreshToken
          user: requestBody.user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an access token with program credentials
      effect: write
      questions:
      - How do I get a bearer token to call the Leadspace v4 APIs?
      - What credentials do I exchange for an API access token, and how long does it last?
      - Which audience value is needed when requesting a token for the v4 gateway?
      instructions:
      - text: Request a new access token using program ID {user} and secret {pass} for audience {audience}.
        slots:
          user: requestBody.user
          pass: requestBody.pass
          audience: requestBody.audience
      - text: Log in with program ID {user} and secret {pass} to get a fresh 24-hour bearer token scoped to {audience}.
        slots:
          user: requestBody.user
          pass: requestBody.pass
          audience: requestBody.audience
      method: generated
      generated: '2026-10-01'