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). v3 has three list maxima rather than one norm: 250 on responses, surveys and the reference lists, 1000 on feedbackRecords, and 100 here. The workflows bound lives in the shared packages/workflows contracts, owned alongside the feature rather than by this spec, which is why it did not move with the others. Documented at the value actually enforced; tracked separately.

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: draft → enabled, enabled ↔ disabled, enabled/disabled → draft, any non-archived state → archived (archive), and archived → draft (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
includeTotalCount
boolean
default:false

When true, meta.totalCount is the number of workflows matching the same filters across all pages; otherwise it is null. Values other than true/false → 400.

Response

Workflows retrieved successfully

data
object[]
required
meta
object
required

A list meta carrying pagination and the filtered total. totalCount is required but nullable, gated on the operation's includeTotalCount parameter.