Skip to main content
GET
Get paginated workflow execution history

Path Parameters

id
string
required

The workflow execution ID

Query Parameters

runId
string

Specific run ID. Required when using pageToken.

pageSize
integer
default:20

Number of events per page

Required range: 1 <= x <= 50
pageToken
string

Base64 pagination token from previous response

includePayloads
boolean
default:false

Include decoded input/output payloads in events

longPollTimeoutMs
integer

When set, long-poll for a new event once caught up to the end of history instead of returning immediately, bounding the block by this many milliseconds. Clamped to the server's configured maximum — a caller can shorten the wait but never exceed it. Omit for an immediate response; on timeout returns the same page's cursor unchanged with an empty events array so the caller can retry. Lets a poller keep the block roughly aligned with its own tick interval.

Required range: x >= 1

Response

Paginated history events

workflow
object | null

Workflow metadata (null on subsequent pages)

events
object[]
runId
string

Resolved run ID. Echo this value as the runId query parameter when fetching subsequent pages.

nextPageToken
string | null