Square · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Square Locations API

5 actions 5 updates phrasing extends openapi/square-locations-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 5

$.info
$.paths['/v2/locations'].get
$.paths['/v2/locations'].post
$.paths['/v2/locations/{location_id}'].get
$.paths['/v2/locations/{location_id}'].put

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 Square Locations API
  version: 1.0.0
extends: openapi/square-locations-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['/v2/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List all business locations
      effect: read
      questions:
      - Which locations does my Square account have, including inactive ones?
      - How do I get the location IDs for all my stores?
      instructions:
      - text: List all my locations.
      - text: Show every store location alphabetically, including inactive ones.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/locations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a business location
      effect: write
      questions:
      - Can I add a new store location through the API?
      - Why would I create separate locations for my business?
      instructions:
      - text: Create location {location}.
        slots:
          location: requestBody.location
      - text: Add a new store with the details in {location}.
        slots:
          location: requestBody.location
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/locations/{location_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one location
      effect: read
      questions:
      - What address and hours are set for a specific location?
      - How can I fetch my main location without knowing its ID?
      instructions:
      - text: Get location {location_id}.
        slots:
          location_id: path.location_id
      - text: Show address and business hours for location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/locations/{location_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a location
      effect: write
      questions:
      - Can I change a location's business hours or address?
      - How do I rename one of my store locations?
      instructions:
      - text: Update location {location_id} with {location}.
        slots:
          location_id: path.location_id
          location: requestBody.location
      - text: Change the business hours of location {location_id} to match {location}.
        slots:
          location_id: path.location_id
          location: requestBody.location
      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-locations-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.

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