sdkDeterministic

Get workflow

pipeline.getWorkflow

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.

Parameters

workspaceId

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.

Example

TypeScripttypescript

await pipeline.getWorkflow({
  "workflowId": "00000000-0000-4000-8000-000000000000"
})

Response

The operation is available, but its typed response schema has not been published yet.

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.