Generated by API Evangelist
Written by API Evangelist tooling for Square's API. It is a proposal applied on top of the contract, not a document Square publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Square OAuth API
version: 1.0.0
extends: openapi/square-oauth-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: 3
- target: $.paths['/oauth2/revoke'].post
update:
x-apievangelist-phrasing:
intent: Revoke a seller's OAuth access
effect: destructive
questions:
- How do I disconnect my app from a seller's Square account?
- Does revoking one token revoke every token for that seller?
instructions:
- text: Revoke access token {access_token} for app {client_id}.
slots:
access_token: requestBody.access_token
client_id: requestBody.client_id
- text: Revoke all of my app's tokens for merchant {merchant_id}.
slots:
merchant_id: requestBody.merchant_id
method: generated
generated: '2026-09-26'
- target: $.paths['/oauth2/token'].post
update:
x-apievangelist-phrasing:
intent: Get or refresh an OAuth access token
effect: write
questions:
- How do I exchange an authorization code for an access token?
- Can I refresh an expired access token with a refresh token?
- Is there a way to get only a short-lived token?
instructions:
- text: Exchange code {code} for a token for app {client_id} with grant type {grant_type}.
slots:
code: requestBody.code
client_id: requestBody.client_id
grant_type: requestBody.grant_type
- text: Refresh the token using {refresh_token} for client {client_id}, grant {grant_type}.
slots:
refresh_token: requestBody.refresh_token
client_id: requestBody.client_id
grant_type: requestBody.grant_type
method: generated
generated: '2026-09-26'
- target: $.paths['/oauth2/token/status'].post
update:
x-apievangelist-phrasing:
intent: Check an access token's status
effect: read
questions:
- When does my current access token expire?
- Which scopes and merchant does this token belong to?
instructions:
- text: Check the status of my access token.
- text: Show the scopes and expiry of the token I'm using.
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.