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

• checksum — copy 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

DevAuth

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

400

Bad Request

application/json

404

Not Found — no workflow for the given entity-id

application/json

500

Internal Server Error

application/json

get

/dev/v1/workflow/{entity-id}

HTTPcURLJavaScriptPython

GET /dev/v1/workflow/{entity-id} HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "Order_Discount_Workflow",
    "description": "Calculates discount for an order based on cart total and customer tier.",
    "startNode": "node_abc123codenode01",
    "version": "draft",
    "status": "draft",
    "comment": "",
    "isEnabled": true,
    "settings": {
      "auditIO": true,
      "dateFormat": "in",
      "timezone": "Asia/Kolkata"
    },
    "trigger": {
      "apiNode": "1"
    },
    "staticUrl": "https://nected-59.nected.io/nected/workflow/a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "versionInfo": null,
    "dependencyMap": [],
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-05-10T14:22:11.123Z",
    "publishedAt": "2026-03-01T08:00:00.000Z",
    "testedAt": "2026-05-10T14:20:00.000Z",
    "checksum": "7f3d2a1b9c8e4f6a0d5b2c7e1a9f3d8c",
    "isLive": false,
    "nodes": [
      {
        "id": "1",
        "type": "trigger",
        "position": {
          "x": 687.5,
          "y": 0
        },
        "style": null,
        "sourcePosition": "bottom",
        "targetPosition": "top",
        "draggable": false,
        "data": {
          "nodeType": "apiTrigger",
          "name": "Trigger",
          "input": {
            "orderId": {
              "name": "orderId",
              "dataType": "string",
              "executedValue": "ORD-20260101-9921",
              "isCaseSensitive": false,
              "isNullable": false,
              "isOptional": false,
              "keyAttribute": "",
              "keySource": "",
              "mapping": false,
              "notSend": false,
              "order": 0,
              "schemaId": "",
              "sendNull": false,
              "source": "",
              "attribute": "",
              "value": null
            },
            "cartTotal": {
              "name": "cartTotal",
              "dataType": "numeric",
              "executedValue": 1250,
              "isCaseSensitive": false,
              "isNullable": false,
              "isOptional": false,
              "keyAttribute": "",
              "keySource": "",
              "mapping": false,
              "notSend": false,
              "order": 1,
              "schemaId": "",
              "sendNull": false,
              "source": "",
              "attribute": "",
              "value": null
            },
            "customerTier": {
              "name": "customerTier",
              "dataType": "string",
              "executedValue": "gold",
              "isCaseSensitive": false,
              "isNullable": false,
              "isOptional": false,
              "keyAttribute": "",
              "keySource": "",
              "mapping": false,
              "notSend": false,
              "order": 2,
              "schemaId": "",
              "sendNull": false,
              "source": "",
              "attribute": "",
              "value": null
            }
          },
          "output": null,
          "settings": {
            "authType": "none",
            "isEnabled": true
          },
          "executedValue": {
            "orderId": "ORD-20260101-9921",
            "cartTotal": 1250,
            "customerTier": "gold"
          },
          "entity": "",
          "entityId": "",
          "pluginName": "",
          "status": "",
          "rootId": "",
          "sourceIds": null,
          "isMergeNode": false,
          "switcher": null,
          "conditions": null,
          "blockName": "",
          "runInLoop": {
            "status": false,
            "source": "",
            "attribute": "",
            "value": null
          }
        }
      },
      {
        "id": "node_abc123codenode01",
        "type": "codeNode",
        "position": {
          "x": 687.5,
          "y": 205
        },
        "style": null,
        "sourcePosition": "bottom",
        "targetPosition": "top",
        "draggable": false,
        "data": {
          "nodeType": "codeNode",
          "name": "Calculate_Discount",
          "entity": "codeNode",
          "entityId": "node_abc123codenode01",
          "pluginName": "",
          "status": "success",
          "rootId": "",
          "sourceIds": null,
          "isMergeNode": false,
          "switcher": null,
          "conditions": null,
          "blockName": "",
          "input": {
            "language": {
              "value": "excelFormula"
            },
            "snippet": {
              "value": "let cartTotal = {{.Trigger.cartTotal}};\nlet tier = {{.Trigger.customerTier}};\nlet discountPct = 0;\nif (tier === 'gold') { discountPct = 15; }\nelse if (tier === 'silver') { discountPct = 10; }\nelse { discountPct = 5; }\nlet discountAmount = cartTotal * discountPct / 100;\nlet finalAmount = cartTotal - discountAmount;\n{ discountPct, discountAmount, finalAmount };"
            }
          },
          "output": null,
          "settings": {
            "errorContinue": false,
            "timeout": 10,
            "timeoutAsync": 20
          },
          "executedValue": {
            "error": "",
            "executionTime": "1ms",
            "output": {
              "discountPct": 15,
              "discountAmount": 187.5,
              "finalAmount": 1062.5
            }
          },
          "runInLoop": {
            "status": false,
            "source": "",
            "attribute": "",
            "value": null
          }
        }
      }
    ],
    "edges": [
      {
        "id": "edge_trigger_to_add1",
        "source": "1",
        "target": "node_abc123addnode01",
        "type": "smoothEdge",
        "animated": false,
        "label": "",
        "markerEnd": "",
        "sourceHandle": "",
        "style": {
          "stroke": "gray",
          "strokeWidth": 1
        },
        "data": {
          "edgeType": "then",
          "pathId": ""
        }
      },
      {
        "id": "edge_add1_to_code",
        "source": "node_abc123addnode01",
        "target": "node_abc123codenode01",
        "type": "smoothEdge",
        "animated": false,
        "label": "",
        "markerEnd": "",
        "sourceHandle": "",
        "style": {
          "stroke": "gray",
          "strokeWidth": 1
        },
        "data": {
          "edgeType": "then",
          "pathId": ""
        }
      },
      {
        "id": "edge_code_to_add2",
        "source": "node_abc123codenode01",
        "target": "node_abc123addnode02",
        "type": "smoothEdge",
        "animated": false,
        "label": "",
        "markerEnd": "",
        "sourceHandle": "",
        "style": {
          "stroke": "gray",
          "strokeWidth": 1
        },
        "data": {
          "edgeType": "then",
          "pathId": ""
        }
      }
    ]
  },
  "code": "success",
  "message": "Success."
}

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

9KB

GET_BY_ID.json

Open

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

Use the API reference below to try the endpoint.