Skip to main content
GET
List events

Authorizations

x-api-key
string
header
required

Query Parameters

cursor
string

Opaque cursor from a previous response. Send meta.nextCursor with direction=forward to read the next page, or meta.previousCursor with direction=backward to read the previous page.

Maximum string length: 500
limit
number
default:20

Maximum number of results to return (1-100)

Required range: 1 <= x <= 100
direction
enum<string>

Which side of the cursor to read: forward returns the rows after it, backward the rows before it. Rows come back in list order either way. Without a cursor, forward starts at the first row and backward at the end of the list.

Available options:
forward,
backward
type
string

Filter by event type (exact match, e.g. transaction.completed). An unknown value returns an empty page. Read the current list from GET /v2/webhooks/event-types.

Required string length: 1 - 100
createdFrom
string<date-time>

Return only events that occurred at or after this time (ISO 8601).

Response

data
object[]
required
meta
object
required