Skip to main content
GET
List events

Authorizations

Authorization
string
header
required

OrgX API key, sent as Authorization: Bearer oxk_...

Headers

Last-Event-ID
string

Opaque cursor returned in the previous SSE event id field.

Query Parameters

workspace_id
string<uuid>
required
cursor
string

Opaque cursor returned as meta.nextCursor.

limit
integer
default:50
Required range: 1 <= x <= 100
event_type
string[]

Repeat to filter accepted events by ledger event type.

aggregate_type
string
Pattern: ^[a-z][a-z0-9_.-]{0,99}$
transport
enum<string>
default:json

Use sse for a bounded Server-Sent Events lease.

Available options:
json,
sse
after
string

Opaque SSE replay cursor. Equivalent to Last-Event-ID.

stream_ms
integer
default:60000

Maximum SSE lease duration in milliseconds.

Required range: 1 <= x <= 300000
poll_ms
integer
default:1000

Ledger polling interval for the SSE lease in milliseconds.

Required range: 1 <= x <= 10000

Response

Replayable ledger event page or bounded SSE lease

data
object[]
required
meta
object
required