Automations · Workflows
Returns workflow runs, one page at a time.
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication
Path parameters
| Name | Type | Notes |
|---|---|---|
workflowIdrequired | string |
Query parameters
| Name | Type | Notes |
|---|---|---|
status | string | One of running, waiting, completed, exited, failed |
limit | integer | Default 25 |
skip | integer | Default 0 |
Example
curl -X GET "https://api.pozy.ai/v1/workflows/6e299f518f373bfd669857c4/executions?limit=25" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/workflows/6e299f518f373bfd669857c4/executions?limit=25", {
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/executions",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
params={
"limit": 25,
},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
successbooleanexecutionsarray of object13 child fields
idstringstatusstringOne of
running,waiting,completed,exited,failed.currentNodeIdstringwaitingForobjectCan be null.
2 child fields
kindstringOne of
timer,reply.nodeIdstring
variablesobjectplatformIdentifierstringconversationIdstringCan be null.
stepCountintegerlastErrorstringCan be null.
resumeAtstring (date-time)Can be null.
createdAtstring (date-time)updatedAtstring (date-time)completedAtstring (date-time)Can be null.
paginationobjecttotalintegerlimitintegerskipintegerhasMoreboolean
200 response
{
"success": true,
"executions": [
{
"id": "6bfebd43ddc270f6d2c56fc5",
"status": "running",
"currentNodeId": "6824a29c1481b019b3350794",
"waitingFor": {
"kind": "timer",
"nodeId": "661065480d0716ebcd3f1af3"
},
"variables": {},
"platformIdentifier": "instagram",
"conversationId": "6e525f3820fc636aa96d2ee9",
"stepCount": 42,
"lastError": "string",
"resumeAt": "2026-10-02T09:00:00.000Z",
"createdAt": "2026-10-02T09:00:00.000Z",
"updatedAt": "2026-10-02T09:00:00.000Z",
"completedAt": "2026-10-02T09:00:00.000Z"
}
],
"pagination": {
"total": 42,
"limit": 1,
"skip": 1,
"hasMore": true
}
}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 workflowsPOSTCreate workflowGETGet workflow with graphPATCHUpdate workflowDELDelete workflowPOSTActivate workflowPOSTPause workflowPOSTManually start a workflow runPOSTStart an API-triggered workflowGETGet an execution's timelinePOSTDuplicate a workflowGETList a workflow's version historyGETGet a specific workflow versionPOSTRestore a workflow version