For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get workflow by ID

Retrieve the full workflow document by its entity ID. Optionally pass a version query parameter to fetch a specific published version instead of the draft.

Get workflow by id

get

Retrieve the full workflow document by entity ID — the complete graph including nodes, edges, startNode, trigger, settings, plus all server fields.

Response data fields:

  • id, name, description, startNode, nodes, edges, trigger — the full graph

  • version, status, isEnabled, comment, settings — runtime config

  • checksumcopy this for every subsequent update, test, or publish call

  • staticUrl, versionInfo, dependencyMap, createdAt, updatedAt, publishedAt, testedAt, isLive — server metadata

GET data ≈ POST body + server fields. You can take data, strip id/checksum/timestamps/version/status/staticUrl/versionInfo, and use it directly as a create or update body.

version query param: pass a published version label (e.g. v1) to retrieve that version's graph instead of the draft.

Canonical response file: Get/GET_BY_ID.json

Authorizations
Nected-API-KeystringRequired

Your Nected API key. Obtain from your workspace settings.

Path parameters
entity-idstringRequired

The workflow entity ID (from create response data.id)

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890
Query parameters
versionstringOptional

Specific published version to fetch (e.g. v1). Omit for the draft.

Example: v1
Header parameters
Nected-BranchstringOptional

Branch name (optional)

Responses
200

OK — full workflow document.

application/json

Success response for GET /dev/v1/workflow/{entity-id} — full workflow document

codestringOptional
messagestringOptional
get
/dev/v1/workflow/{entity-id}

Response shape

The API returns the standard wrapper: code, message, and data.

  • data is the full workflow object: all nodes, edges, startNode, trigger, settings, plus server fields id, checksum, version, status, staticUrl, versionInfo, and timestamps.

  • So: GET data ≈ POST body + id + checksum + server metadata — you can submit data (minus server-only fields) directly as a create or update body.

Full 200 example

Replace example id / checksum values in GET_BY_ID.json with values from your environment.

Use the API reference below to try the endpoint.

Last updated