---
title: "List Workflows"
method: GET
path: "/v1/{workspace}/workflow/"
---

# List Workflows

`GET /v1/{workspace}/workflow/`

Retrieve a list of workflows in a workspace.

## Path parameters

- `workspace` string, required

## Query parameters

- `mode` 'draft' | 'live'
- `slugs` string

## Response `200`

Successfully retrieved list of workflows

- object
  - `meta` object — Metadata related to pagination information
    - `count` integer — Total number of workflows matching the query
    - `limit` integer — Number of results returned per page
    - `offset` integer — Offset value passed in the request
  - `results` Workflow[] — Array of workflows along with their node tree.
    - `$schema` string, uri — Schema URL for workflow validation
    - `slug` string — Unique identifier for the workflow
    - `is_enabled` boolean — Whether the workflow is enabled
    - `created_at` string, date-time — When the workflow was created
    - `last_executed_at` string, date-time, nullable — When the workflow was last executed
    - `name` string — Human-readable name of the workflow
    - `description` string, nullable — Description explaining the usecase of the workflow
    - `updated_at` string, date-time — When the workflow was last updated
    - `commit_message` string, nullable — Last commit message
    - `hash` string, nullable — Git-like hash for version tracking
    - `status` 'active' | 'inactive' | 'draft' — Current status of the workflow
    - `category` string — Notification category of the workflow. Used to apply category-specific settings and preferences.
    - `tags` string[] — Tags for organizing and filtering workflows in API.
    - `ratelimit` object, nullable — Workflow [throttle](https://docs.suprsend.com/docs/throttle) settings. This is used to limit the number of times a workflow can be executed per user in a given time period.
    - `conditions` object[] — Trigger Conditions for workflow execution. Workflow will only be executed if trigger conditions evaluate to true.
    - `trigger_type` 'event' | 'dynamic' | 'api' — How the workflow is triggered. You can refer to all trigger types [here](https://docs.suprsend.com/reference/trigger-workflows#trigger-types).
    - `trigger_events` string[] — Events that trigger this workflow. This will be set for trigger_type = `event`.
    - `override_recipients_type` 'user' | 'single_object_fields', nullable — Type of recipient override. Define whether to override and run this workflow for user, list of users or a single object.
    - `override_recipients_user_expr` string, nullable — Expression for overriding recipients when override_recipients_type = `user`.
    - `override_recipients_single_object_fields_expr` string, nullable — Expression for overriding recipients when override_recipients_type = `single_object_fields`.
    - `override_actor_user_expr` string, nullable — Expression for overriding actor
    - `override_tenant_expr` string, nullable — Expression for overriding tenant
    - `active_at` string, date-time — When the workflow's live version became active. Will be `null` for draft version.
    - `updated_by` object, nullable — User who last updated the workflow
      - `name` string — Name of the user who last updated the workflow
      - `email` string, email — Email of the user who last updated the workflow
    - `tree` object — Node tree structure of the workflow. Shows the list of all nodes used in the workflow along with their configuration.
    - `validation_result` object — Validation status of the workflow
      - `is_valid` boolean — true if the workflow tree is valid to be published.
      - `errors` string[] — List of errors if the workflow tree is not valid.

## Other responses

- `401` — Authentication failed
- `404` — Resource not found

---

[API](https://skmtc.net/suprsend/apis/suprsend-api.md) · [All operations](https://skmtc.net/suprsend/apis/suprsend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/suprsend/suprsend-api/versions/8bd2574bd2c3/schema)