Square

Square Events API

The Events API from Square — 4 operation(s) for events.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /v2/events Search recent API events · Square Search Events #

Ask an LLM

“How do I find Square API events from the last few weeks?”

“Can I filter events by type or merchant within the 28-day window?”

Tell an agent

Search events matching {query}.

Show the latest {limit} API events.

PUT /v2/events/disable Turn off event searchability · Square Disable Events #

Ask an LLM

“How do I stop events from being searchable?”

“What happens to events that occur while searching is disabled?”

Tell an agent

Disable events search.

Stop recording searchable events for my app.

PUT /v2/events/enable Turn on event searchability · Square Enable Events #

Ask an LLM

“How do I make events searchable for my application?”

“Are events searchable by default, or must I enable them?”

Tell an agent

Enable events search.

Start making new events searchable.

GET /v2/events/types List event types · Square List Event Types #

Ask an LLM

“What event types can I query or subscribe to?”

“Does the list of event types change with the API version?”

Tell an agent

List all event types for event search.

Show event types for API version {api_version} that I can query.

Documentation

https://developer.squareup.com/docs/payments-overview

https://developer.squareup.com/reference/square/payments-api

https://developer.squareup.com/docs/orders-api/what-it-does

https://developer.squareup.com/reference/square/orders-api

https://developer.squareup.com/docs/catalog-api/what-it-does

https://developer.squareup.com/reference/square/catalog-api

https://developer.squareup.com/docs/inventory-api/what-it-does

https://developer.squareup.com/reference/square/inventory-api

https://developer.squareup.com/docs/customers

https://developer.squareup.com/reference/square/customers-api

https://developer.squareup.com/docs/locations-api

https://developer.squareup.com/reference/square/locations-api

https://developer.squareup.com/docs/team/overview

https://developer.squareup.com/reference/square/team-api

https://developer.squareup.com/docs/labor-api/what-it-does

https://developer.squareup.com/reference/square/labor-api

https://developer.squareup.com/docs/bookings-api/what-it-is

https://developer.squareup.com/reference/square/bookings-api

https://developer.squareup.com/docs/loyalty-api/overview

https://developer.squareup.com/reference/square/loyalty-api

https://developer.squareup.com/docs/gift-cards/using-gift-cards-api

https://developer.squareup.com/reference/square/gift-cards-api

https://developer.squareup.com/docs/invoices-api/overview

https://developer.squareup.com/reference/square/invoices-api

https://developer.squareup.com/docs/subscriptions-api/overview

https://developer.squareup.com/reference/square/subscriptions-api

https://developer.squareup.com/docs/checkout-api

https://developer.squareup.com/reference/square/checkout-api

https://developer.squareup.com/docs/terminal-api/overview

https://developer.squareup.com/reference/square/terminal-api

https://developer.squareup.com/docs/payments-refunds

https://developer.squareup.com/reference/square/refunds-api

https://developer.squareup.com/docs/disputes-api/overview

https://developer.squareup.com/reference/square/disputes-api

https://developer.squareup.com/docs/merchants-api

https://developer.squareup.com/reference/square/merchants-api

https://developer.squareup.com/docs/cards-api/overview

https://developer.squareup.com/reference/square/cards-api

https://developer.squareup.com/docs/vendors-api/manage-vendors-in-apps

https://developer.squareup.com/reference/square/vendors-api

https://developer.squareup.com/docs/cashdrawershift-api/reporting

https://developer.squareup.com/reference/square/cash-drawers-api

https://developer.squareup.com/docs/bank-accounts-api

https://developer.squareup.com/reference/square/bank-accounts-api

https://developer.squareup.com/docs/payouts-api/overview

https://developer.squareup.com/reference/square/payouts-api

https://developer.squareup.com/docs/web-payments/apple-pay

https://developer.squareup.com/reference/square/apple-pay-api

https://developer.squareup.com/docs/sites-api/overview

https://developer.squareup.com/reference/square/sites-api

https://developer.squareup.com/docs/snippets-api/overview

https://developer.squareup.com/reference/square/snippets-api

https://developer.squareup.com/docs/oauth-api/overview

https://developer.squareup.com/reference/square/oauth-api

https://developer.squareup.com/docs/webhooks/overview

https://developer.squareup.com/reference/square/webhook-subscriptions-api

https://developer.squareup.com/docs/events-api/overview

https://developer.squareup.com/reference/square/events-api

https://developer.squareup.com/docs/devices-api/overview

https://developer.squareup.com/reference/square/devices-api

https://developer.squareup.com/docs/customer-groups-api/what-it-does

https://developer.squareup.com/reference/square/customer-groups-api

https://developer.squareup.com/docs/customer-segments-api/what-it-does

https://developer.squareup.com/reference/square/customer-segments-api

https://developer.squareup.com/docs/gift-cards/using-gift-card-activities-api

https://developer.squareup.com/reference/square/gift-card-activities-api

https://developer.squareup.com/docs/customer-custom-attributes-api/overview

https://developer.squareup.com/reference/square/customer-custom-attributes-api

Specifications

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-events-api-openapi.yml

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/asyncapi/square-webhooks-asyncapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-search-events-response-schema.json

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-search-events-request-schema.json

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-list-event-types-response-schema.json

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-disable-events-response-schema.json

https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/json-schema/square-enable-events-response-schema.json

Work with this as data

Every API 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 apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
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 API

curl "https://apis.io/api/v1/apis/square:square-events-api"

All apis

curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '2.0'
  title: Square Events API
  description: Supercharge Square for sellers of every size. Our entire connected commerce platform from elegant hardware to a rich suite of Square APIs is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen.
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:


# --- truncated at 32 KB (63 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-events-api-openapi.yml