Skip to main content
GET
List workflows

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.

filter[name][contains]
string

Case-insensitive substring match on workflow name (same semantics as the survey list filter).

Maximum string length: 512
filter[status][in]
enum<string>[]

Workflow lifecycle-state filter. Repeat the parameter (filter[status][in]=draft&filter[status][in]=disabled) or use comma-separated values (filter[status][in]=draft,disabled). Omitting the filter returns every status except archived. Invalid values → 400.

Workflow lifecycle state. draft workflows are editable and inert. enabled workflows respond to trigger events. disabled workflows keep their configuration but are inert. archived workflows are soft-deleted: read-only, excluded from default list reads, and restorable via unarchive.

Status only changes through lifecycle endpoints. Valid transitions: draftenabled, enableddisabled, enabled/disableddraft, any non-archived state → archived (archive), and archiveddraft (unarchive).

Available options:
draft,
enabled,
disabled,
archived
sortBy
enum<string>

Sort order. Defaults to updatedAt (newest first). The cursor token is bound to the selected sort order.

Available options:
createdAt,
updatedAt,
name

Response

Workflows retrieved successfully

data
object[]
required
meta
object
required