FOformbricks
V3 Workflows

List workflows

Changed on

Returns workflow list items for a workspace, sorted by sortBy (default updatedAt, newest first). Workflows are workspace-scoped and exposed through the same v3 session-or-API-key authorization model as surveys.

List items are intentionally slim: they include the derived triggerType and surveyId plus a lastRun summary, but not the full definition. Use GET /api/v3/workflows/{workflowId} to read the definition.

archived workflows are excluded unless explicitly requested with filter[status][in]=archived.

get/api/v3/workflows

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/workflows
  • Auth
    • API key in cookie next-auth.session-token
    • or API key in header x-api-key
    • or HTTP bearer

Query parameters

workspaceIdstring cuid2 required

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

limitinteger

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.

cursorstring

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).

filter[status][in]WorkflowStatus[]

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.

sortBy'createdAt' | 'updatedAt' | 'name'

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

includeTotalCountboolean

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

Changes

  • 82c0afd2df39Revision changes
    • info

      added the new optional query request parameter includeTotalCount

    • info

      added subschema #2 to the response property allOf list for the response status

  • 84820a01e550Revision changes
    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new chart_in_use enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new dashboards_plan_required enum value to the response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status

    • warning

      added the new limit_exceeded enum value to the // response property for the response status