FOformbricks
V3 Workflows

List workflow runs

Changed on

Returns workflow run summaries for a workspace, newest first (createdAt descending). Use workflowId to narrow the list to one workflow, or responseId to find the runs a specific survey response produced.

List items are summaries without triggerPayload, data, or logs; fetch GET /api/v3/workflows/runs/{runId} for the full debug-oriented payload. This keeps response-level data out of list reads by default.

get/api/v3/workflows/runs

Request

  • Base URL
    https://app.formbricks.com
  • URL
    https://app.formbricks.com/api/v3/workflows/runs
  • 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). The workflows endpoints have not yet moved to the v3-wide maximum of 250 — their bound lives in the shared packages/workflows contracts, which are owned alongside the workflows feature rather than by this spec. Documented at the value actually enforced rather than at the platform norm; tracked separately.

cursorstring

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

workflowIdstring cuid2

Optional workflow scoping. Returns only runs of this workflow.

responseIdstring cuid2

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

filter[status][in]WorkflowRunStatus[]

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

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

Changes

  • 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

  • aad5dc1d8236Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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