Get Workflow | extend

import { ExtendClient } from "extend-ai";
async function main() {
    const client = new ExtendClient({
        token: "YOUR_TOKEN_HERE",
        extendApiVersion: "2026-02-09",
    });
    await client.workflows.retrieve("workflow_abc123");
}
main();

{
  "object": "workflow",
  "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
  "name": "Invoice Processing",
  "createdAt": "2024-03-21T16:45:00Z",
  "updatedAt": "2024-03-21T16:45:00Z",
  "draftVersion": {
    "object": "workflow_version",
    "id": "workflow_version_Zk9mNP12Qw4-yTv8BdR3H",
    "version": "1",
    "name": "Production v1",
    "steps": [
      {
        "name": "string",
        "type": "TRIGGER",
        "next": [
          {
            "step": "parse"
          }
        ]
      }
    ],
    "createdAt": "2024-03-21T16:45:00Z"
  }
}

Get details of a workflow, including its draft version and steps.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

The ID of the workflow.

Response

Workflow details

objectenum

The type of object. Always "workflow".

Allowed values:

idstring

The ID of the workflow.

namestring

The name of the workflow.

createdAtstringformat: "date-time"

The time (in UTC) at which the object was created. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

updatedAtstringformat: "date-time"

The time (in UTC) at which the object was last updated. Will follow the RFC 3339 format.

Example: "2024-03-21T16:45:00Z"

draftVersionobject

A workflow version with its step definitions.

Errors

400

Bad Request Error

401

Unauthorized Error

402

Payment Required Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response

Errors