Get Workflow Run

Read one workflow run

GET /api/v1/workflow-runs/:workflowRunId

Node.js

const options = {
  method: "GET",
  headers: { "x-api-key": "<your-api-key>" },
};

fetch(
  "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
  options,
)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

200

{
  "success": true,
  "workflowRun": {
    "id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
    "agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "portalUrl": null,
    "externalId": null,
    "status": "ACTIVE",
    "createdAt": "2026-09-10T17:42:03.000Z",
    "completedAt": null,
    "cancelledAt": null
  }
}

Read a single workflow run: one agent conducting one workflow on one lead.

Authentication

Requires the x-api-key header with a valid workspace API key.

Path Parameters

workflowRunId · string · required

The workflow run id returned by Create Workflow Run.

Response

success · boolean

Whether the request succeeded.

workflowRun · object

The workflow run.

Show workflowRun

id · string

The workflow run id. This is what pause, resume, cancel, and complete act on, and what the workflow_run.* webhooks carry as workflowRun.id.

leadId · string

The lead the workflow is conducted on.

agentId · string

The agent conducting the workflow. Look the name up with List Agents.

workflowId · string

The workflow being conducted. Look the name and type up with List Workflows.

portalUrl · string | null

The portal URL for this run, or null. When set, it is the link the lead receives, overriding the lead’s own portal link and the workflow’s portal URL template.

externalId · string | null

Your identifier for this run, or null. Set it when you create the run.

status · string

ACTIVE, PAUSED, COMPLETED, or CANCELLED. The last two are final.

createdAt · string

When the workflow run started.

completedAt · string | null

When the workflow run completed, or null.

cancelledAt · string | null

When the workflow run was cancelled, or null.

Errors

404 · error

No workflow run with this id exists in your workspace.

Node.js

const options = {
  method: "GET",
  headers: { "x-api-key": "<your-api-key>" },
};

fetch(
  "https://api-v2.getomni.ai/api/v1/workflow-runs/5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
  options,
)
  .then((response) => response.json())
  .then((response) => console.log(response))
  .catch((err) => console.error(err));

200

{
  "success": true,
  "workflowRun": {
    "id": "5d8c1b2a-3e4f-5061-7283-94a5b6c7d8e9",
    "leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
    "agentId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "workflowId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "portalUrl": null,
    "externalId": null,
    "status": "ACTIVE",
    "createdAt": "2026-09-10T17:42:03.000Z",
    "completedAt": null,
    "cancelledAt": null
  }
}