Sign in

v2

latestOpenAPI 3.1.12026-07-2613060964.2 KB

List Workflows

Retrieve a list of workflows in a workspace.

get/v1/{workspace}/workflow/

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

Query parameters

mode'draft' | 'live'

Mode to filter workflows (draft or live). By default, draft workflows are returned.

slugsstring

Comma-separated list of workflow slugs to filter. This can be used to filter workflows by slug.

Response

Successfully retrieved list of workflows

Example response

{
  "meta": {
    "count": 92,
    "limit": 10
  },
  "results": [
    {
      "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
      "slug": "welcome-sequence",
      "is_enabled": true,
      "name": "Welcome Sequence",
      "category": "transactional"
    }
  ]
}