Square · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Square Devices API

6 actions 6 updates phrasing extends openapi/square-devices-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/v2/devices'].get

$.paths['/v2/devices/codes'].get

$.paths['/v2/devices/codes'].post

$.paths['/v2/devices/codes/{id}'].get

$.paths['/v2/devices/{device_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 Square Devices API
  version: 1.0.0
extends: openapi/square-devices-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: 5
- target: $.paths['/v2/devices'].get
  update:
    x-apievangelist-phrasing:
      intent: List Terminal devices
      effect: read
      questions:
      - Which Square Terminal devices are connected to my account?
      - Can I list devices at one location only?
      instructions:
      - text: List my Terminal devices.
      - text: Show devices at location {location_id}.
        slots:
          location_id: query.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/devices/codes'].get
  update:
    x-apievangelist-phrasing:
      intent: List device pairing codes
      effect: read
      questions:
      - What device codes have I created for pairing terminals?
      - Can I filter device codes by status, like unpaired or expired?
      instructions:
      - text: List all device codes.
      - text: Show {status} device codes at location {location_id}.
        slots:
          status: query.status
          location_id: query.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/devices/codes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a code to pair a Terminal
      effect: write
      questions:
      - How do I pair a new Square Terminal with my app?
      - Can I generate a login code for a Terminal at a specific location?
      instructions:
      - text: Create device code {device_code}.
        slots:
          device_code: requestBody.device_code
      - text: 'Generate a Terminal pairing code: {device_code}.'
        slots:
          device_code: requestBody.device_code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/devices/codes/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a device pairing code
      effect: read
      questions:
      - Has a device code been used to pair a Terminal yet?
      - How do I check one pairing code's status?
      instructions:
      - text: Get device code {id}.
        slots:
          id: path.id
      - text: Check the pairing status of device code {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/devices/{device_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Terminal device
      effect: read
      questions:
      - What are the details and status of one Terminal device?
      - How can I look up a single device by its device ID?
      instructions:
      - text: Get device {device_id}.
        slots:
          device_id: path.device_id
      - text: Show details for Terminal device {device_id}.
        slots:
          device_id: path.device_id
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/square-devices-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.