Square · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Square Gift Card Activities API

3 actions 3 updates phrasing extends openapi/square-giftcardactivities-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 3

$.info

$.paths['/v2/gift-cards/activities'].get

$.paths['/v2/gift-cards/activities'].post

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 Gift Card Activities API
  version: 1.0.0
extends: openapi/square-giftcardactivities-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: 2
- target: $.paths['/v2/gift-cards/activities'].get
  update:
    x-apievangelist-phrasing:
      intent: List gift card activities
      effect: read
      questions:
      - What loads, redemptions and adjustments happened on a gift card?
      - Can I filter gift card activity by type and date range?
      instructions:
      - text: List activities for gift card {gift_card_id}.
        slots:
          gift_card_id: query.gift_card_id
      - text: List {type} gift card activities between {begin_time} and {end_time}.
        slots:
          type: query.type
          begin_time: query.begin_time
          end_time: query.end_time
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/gift-cards/activities'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate, load or redeem a gift card
      effect: write
      questions:
      - How do I activate a gift card with a starting balance?
      - Can I add money to or redeem value from an existing gift card?
      instructions:
      - text: Create gift card activity {gift_card_activity}.
        slots:
          gift_card_activity: requestBody.gift_card_activity
      - text: Record activity {gift_card_activity} with key {idempotency_key} to change the balance.
        slots:
          gift_card_activity: requestBody.gift_card_activity
          idempotency_key: requestBody.idempotency_key
      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-giftcardactivities-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.