Skip to main content
GET
List instances of one workflow

Authorizations

hookie_session
string
cookie
required

The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.

Path Parameters

project_id
string
required
workflow_id
string
required

Query Parameters

state
enum<string>

Exact-match state filter. Unrecognized values simply return an empty list.

Available options:
pending,
running,
waiting,
completed,
failed,
timed_out,
cancelled
since
string<date-time>

Only instances created at or after this instant (ISO 8601). Unparseable → 400.

until
string<date-time>

Only instances created at or before this instant (ISO 8601). Unparseable → 400.

limit
integer

Page size, 1–500 (default 50 when paging). With neither limit nor offset the answer is the newest 500.

Required range: 1 <= x <= 500
offset
integer

Rows to skip, newest first.

Required range: x >= 0

Response

Instances, newest first. Page with limit/offset; total counts every instance matching the filters. context is not included here — use getWorkflowInstance.

instances
object[]
required
total
integer

Instances matching the filters, across all pages.

limit
integer
offset
integer