v1

latestOpenAPI 3.0.02026-07-17301761.7 KB

Get paginated workflow execution history

Returns decoded Temporal history events with optional payload inclusion. First page includes workflow metadata; subsequent pages return events only.

get/workflow/{id}/history

Path parameters

idstring required

The workflow execution ID

Query parameters

runIdstring

Specific run ID. Required when using pageToken.

pageSizeinteger

Number of events per page

pageTokenstring

Base64 pagination token from previous response

includePayloadsboolean

Include decoded input/output payloads in events

longPollTimeoutMsinteger

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.

Response

Paginated history events

workflowobject nullable

Workflow metadata (null on subsequent pages)

eventsobject[]

runIdstring

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

nextPageTokenstring nullable