GET/v1/flows/{id}/nodesflows:read

List nodes for a flow

Run a request

GET/v1/flows/{id}/nodes

Base URL

Path

idrequired

Resolved URL

GEThttps://coldos.justgotwyrd.com/api/v1/flows/{id}/nodes

Paste an API key in the bar at the top of the page to enable Execute.

Parameters

Path parameters

idstringrequired
Flow id.

Responses

400Invalid request — see `error.message`.
401Missing or invalid API key.
403Authenticated, but the key lacks the required scope.
404The referenced resource does not exist or is not visible to your key.
429Rate limit exceeded — see `Retry-After`.
500Unexpected server error. Safe to retry with idempotency-key.

Code samples

curl -X GET "https://coldos.justgotwyrd.com/api/v1/flows/{id}/nodes" \
  -H "Authorization: Bearer $COLD_OS_API_KEY"

Response · 200

{
  "nodes": [
    {
      "id": "node_start",
      "type": "start",
      "position": {
        "x": 0,
        "y": 0
      }
    },
    {
      "id": "node_email_1",
      "type": "email",
      "config": {
        "subject": "Hi {{first_name}}"
      }
    },
    {
      "id": "node_wait_1",
      "type": "delay",
      "config": {
        "duration_hours": 24
      }
    },
    {
      "id": "node_branch_1",
      "type": "condition",
      "config": {
        "predicate": "opened_within_days",
        "days": 1
      }
    }
  ],
  "edges": [
    {
      "from": "node_start",
      "to": "node_email_1"
    },
    {
      "from": "node_email_1",
      "to": "node_wait_1"
    },
    {
      "from": "node_wait_1",
      "to": "node_branch_1"
    }
  ]
}

Was this page helpful?

Your vote stays in this browser. We'll use it to prioritise rewrites.