<- Events API

Events API

Search eventsBeta

POST

 /v2/events

Search for Square API events that occur within a 28-day timeframe.

Guide

Events API

Try in API Explorer
Link to section

Request body

Example code

Link to section

cursor

string

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query.

For more information, see Pagination.

Max Length
256
Link to section

limit

integer(32-bit)

The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value.

For more information, see Pagination.

Default: 100

Min
1
Max
100
Link to section

query

The filtering and sorting criteria for the search request. To retrieve additional pages using a cursor, you must use the original query.

Link to section

Response fields

Link to section

errors

Information on errors encountered during the request.

Link to section

events

The list of Events returned by the search.

Link to section

metadata

Contains the metadata of an event. For more information, see Event.

Link to section

cursor

string

When a response is truncated, it includes a cursor that you can use in a subsequent request to fetch the next set of events. If empty, this is the final response.

For more information, see Pagination.