How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square Events API

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

Square Events API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 4 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

4 operations 4 paths 18 schemas 1 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square Events API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 1 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Events 4
POST
/v2/events
Square Search Events
SearchEvents body → 200
PUT
/v2/events/disable
Square Disable Events
DisableEvents → 200
PUT
/v2/events/enable
Square Enable Events
EnableEvents → 200
GET
/v2/events/types
Square List Event Types
ListEventTypes 1 param → 200

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Event (6 properties), SearchEventsFilter (4 properties), SearchEventsResponse (4 properties), EventData (4 properties). Each schema is shown below with its type and property counts.

SearchEventsSortField
string
Specifies the sort key for events returned from a search.
EventTypeMetadata
object
Contains the metadata of a webhook event type.
3 properties
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
EventData
object
4 properties
Event
object
6 properties
SearchEventsFilter
object
Criteria to filter events by.
4 properties
EnableEventsResponse
object
Defines the fields that are included in the response body of a request to the [EnableEvents](api-endpoint:Events-EnableEvents) endpoint. Note: if there are err…
1 property
EventMetadata
object
Contains metadata about a particular [Event](entity:Event).
2 properties
SearchEventsSort
object
Criteria to sort events by.
2 properties
DisableEventsResponse
object
Defines the fields that are included in the response body of a request to the [DisableEvents](api-endpoint:Events-DisableEvents) endpoint. Note: if there are e…
1 property
TimeRange
object
Represents a generic time range. The start and end values are represented in RFC 3339 format. Time ranges are customized to be inclusive or exclusive based on…
2 properties
SearchEventsResponse
object
Defines the fields that are included in the response body of a request to the [SearchEvents](api-endpoint:Events-SearchEvents) endpoint. Note: if there are err…
4 properties
ListEventTypesResponse
object
Defines the fields that are included in the response body of a request to the [ListEventTypes](api-endpoint:Events-ListEventTypes) endpoint. Note: if there are…
3 properties
SearchEventsQuery
object
Contains query criteria for the search.
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
SortOrder
string
The order (e.g., chronological or alphabetical) in which results from a request are returned.
SearchEventsRequest
object
Searches [Event](entity:Event)s for your application.
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-events-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.