Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Events

SearchEvents

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

post/v2/events

Request body

cursorstring

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.

limitinteger

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

Response

Success

cursorstring

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.

Example response

{
  "cursor": "6b571fc9773647f=",
  "events": [
    {
      "created_at": "2022-04-26T10:08:40.454726",
      "data": {
        "id": "ORSEVtZAJxb37RA1EiGw",
        "object": {
          "dispute": {
            "amount_money": {
              "amount": 8801,
              "currency": "USD"
            },
            "brand_dispute_id": "r9rKGSBBQbywBNnWWIiGFg",
            "card_brand": "VISA",
            "created_at": "2020-02-19T21:24:53.258Z",
            "disputed_payment": {
              "payment_id": "fbmsaEOpoARDKxiSGH1fqPuqoqFZY"
            },
            "due_at": "2020-03-04T00:00:00.000Z",
            "id": "ORSEVtZAJxb37RA1EiGw",
            "location_id": "VJDQQP3CG14EY",
            "reason": "AMOUNT_DIFFERS",
            "reported_at": "2020-02-19T00:00:00.000Z",
            "state": "WON",
            "updated_at": "2020-02-19T21:34:41.851Z",
            "version": 6
          }
        },
        "type": "dispute"
      },
      "event_id": "73ecd468-0aba-424f-b862-583d44efe7c8",
      "location_id": "VJDQQP3CG14EY",
      "merchant_id": "0HPGX5JYE6EE1",
      "type": "dispute.state.updated"
    }
  ],
  "metadata": [
    {
      "api_version": "2022-12-13",
      "event_id": "73ecd468-0aba-424f-b862-583d44efe7c8"
    }
  ]
}