Workflows v2 (Plays) / TypeScript SDK

List workflows

Name: Pipeline
Price: 99 USD

List all custom GTM workflows in the workspace. Each row carries id, name, description, status, schedule, current workflow_definition, and last-run summary. The workspace is inferred from the API key - pass workspace_id only when calling with a multi-workspace key. Read-only.

pipeline.listWorkflowsDeterministic operation

Parameters

workspaceIdOptional · string: Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
workspace_idOptional · string: Workspace UUID. Optional with API key auth - inferred from the key.

Request example

await pipeline.listWorkflows({})

Full input schema

Input schema

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "minLength": 1,
      "description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
    },
    "workspace_id": {
      "type": "string",
      "description": "Workspace UUID. Optional with API key auth - inferred from the key."
    }
  }
}

See this operation inCLI MCP REST API