Automations · Workflows

Get workflow with graph

Fetches a workflow with graph.

GEThttps://api.pozy.ai/v1/workflows/{workflowId}

getWorkflow

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`workflowId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/workflows/6e299f518f373bfd669857c4" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/workflows/6e299f518f373bfd669857c4", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/workflows/6e299f518f373bfd669857c4",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

successboolean
workflowobject
15 child fields
- idstring
- namestring
- descriptionstring
- platformstring
- accountIdstring
- profileIdstring
- statusstring
  One of draft, active, paused.
- entryNodeIdstring
- nodesarray of object
  5 child fields
  idstringrequired
  typestringrequired
  One of trigger, send_message, wait_for_reply, condition, set_variable, delay, webhook, hubspot_upsert_contact, ai, handoff, start_call, a_b_split, set_field, enroll_sequence, add_tag, remove_tag, end.
  configobject
  positionobject
  2 child fields
  xnumber
  ynumber
  labelstring
  1 to 80 characters.
- edgesarray of object
  4 child fields
  idstringrequired
  sourcestringrequired
  targetstringrequired
  sourceHandlestring
  Can be null.
- totalStartedinteger
- totalCompletedinteger
- totalExitedinteger
- createdAtstring (date-time)
- updatedAtstring (date-time)

200 response

{
  "success": true,
  "workflow": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "description": "A short description",
    "platform": "instagram",
    "accountId": "696e0b682d0a31188e7a2ba9",
    "profileId": "6a0b6573846efc28aaa9a3ff",
    "status": "draft",
    "entryNodeId": "6cb80338d0fb8bf8544ff5a4",
    "nodes": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "type": "trigger",
        "config": {},
        "position": {
          "x": 12.5,
          "y": 12.5
        },
        "label": "string"
      }
    ],
    "edges": [
      {
        "id": "6bfebd43ddc270f6d2c56fc5",
        "source": "string",
        "target": "string",
        "sourceHandle": "acme"
      }
    ],
    "totalStarted": 42,
    "totalCompleted": 42,
    "totalExited": 42,
    "createdAt": "2026-10-02T09:00:00.000Z",
    "updatedAt": "2026-10-02T09:00:00.000Z"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Workflows

GETList workflows POSTCreate workflow PATCHUpdate workflow DELDelete workflow POSTActivate workflow POSTPause workflow GETList workflow runs POSTManually start a workflow run POSTStart an API-triggered workflow GETGet an execution's timeline POSTDuplicate a workflow GETList a workflow's version history GETGet a specific workflow version POSTRestore a workflow version