Workflows
Get a workflow's editable draft
Read a workflow’s editable draft — its identity, name, description, factory and canonical typed input contract.
GET
Get a workflow's editable draft
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.
v2 compatibility notes
GET /api/v2/workflows/getDraft?id=<workflowId>
Returns the workflow’s editable draft: the same draft the Forge Console builder edits, read live. An edit made in the builder shows up on the next read; nothing is cached.
The draft is not the published version. Dispatch validates against the active version’s contract, which getInputSchema returns. Read the draft to see what the builder is working on before it is published.
Authentication
External App credential or platform API key. Requires permissionworkflows:read, held at the workflow’s home org unit. The org unit a request acts from is not the workflow’s home.
Query parameters
Responses
The draft’s input contract, in the canonical typed-array shape.
[] means the draft declares no inputs. null means the draft never recorded a contract, which is not the same as declaring none.The published version the draft was opened from. Absent when the draft was not opened from one.

