Skip to main content
GET
List workflow runs

Authorizations

next-auth.session-token
string
cookie
required

NextAuth session JWT cookie. Development: often next-auth.session-token. Production (HTTPS): often __Secure-next-auth.session-token. Send the cookie your browser receives after sign-in.

Query Parameters

workspaceId
string<cuid2>
required

Workspace identifier. This is the canonical container ID for v3 APIs.

limit
integer
default:20

Page size (max 100).

Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned as meta.nextCursor from the previous page. Omit on the first request.

workflowId
string<cuid2>

Optional workflow scoping. Returns only runs of this workflow.

responseId
string<cuid2>

Optional response scoping. Returns only runs triggered by this survey response.

filter[status][in]
enum<string>[]

Run lifecycle-state filter. Repeat the parameter or use comma-separated values (filter[status][in]=failed,canceled). Invalid values → 400.

Workflow run lifecycle state. completed, failed, and canceled are terminal. Valid transitions: queuedrunning, runningqueued (retry/backoff), queuedcanceled, and runningcompleted/failed/canceled. Retries do not introduce a separate status; retry state is exposed via attempt and nextAttemptAt.

Available options:
queued,
running,
completed,
failed,
canceled
filter[isDryRun][eq]
boolean

Filter for dry runs created by POST /api/v3/workflows/{workflowId}/test (true) or for real trigger-initiated runs only (false). Omit to return both.

Response

Workflow runs retrieved successfully

data
object[]
required
meta
object
required