Workflows v2 (Plays) / CLI

Get workflow

Fetch one workflow by id. Returns the full record including workflow_definition (the compiled DAG of plays + edges), status, schedule, and audit metadata. Use after list-workflows to inspect or before run-workflow to verify the version you are about to execute.

pipeline get-workflowDeterministic 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.
workflowIdRequired · string
Workflow UUID.
Request example
pipeline get-workflow \
  --workflow-id "00000000-0000-4000-8000-000000000000"
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."
    },
    "workflowId": {
      "type": "string",
      "description": "Workflow UUID."
    }
  },
  "required": [
    "workflowId"
  ]
}
See this operation inMCP REST API TypeScript SDK
CLI guide | Pipeline v2 preview