For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Book a demoLog in
DocumentationAPI ReferenceModel VersioningChangelog
DocumentationAPI ReferenceModel VersioningChangelog
    • Authentication
    • API Versioning
    • Deployments
    • Error Handling
  • Endpoints
      • POSTRun Workflow
      • POSTBatch Run Workflow
      • GETGet Workflow Run
      • POSTUpdate Workflow Run
      • POSTCancel Workflow Run
      • DELDelete Workflow Run
      • GETList Workflow Runs
      • POSTCreate Workflow
      • GETGet Workflow
      • POSTUpdate Workflow
      • GETList Workflows
      • POSTCreate Workflow Version
      • GETGet Workflow Version
      • GETList Workflow Versions
  • Webhook Events
LogoLogo
Book a demoLog in
EndpointsWorkflows

Get Workflow

GET
/workflows/:id
GET
/workflows/:id
1from extend_ai import Extend
2
3client = Extend(
4    token="YOUR_TOKEN_HERE",
5    extend_api_version="2026-02-09",
6)
7
8client.workflows.retrieve(
9    id="workflow_abc123",
10)
1{
2  "object": "workflow",
3  "id": "workflow_BMlfq_yWM3sT-ZzvCnA3f",
4  "name": "Invoice Processing",
5  "createdAt": "2024-03-21T16:45:00Z",
6  "updatedAt": "2024-03-21T16:45:00Z",
7  "draftVersion": {
8    "object": "workflow_version",
9    "id": "workflow_version_Zk9mNP12Qw4-yTv8BdR3H",
10    "version": "1",
11    "name": "Production v1",
12    "steps": [
13      {
14        "name": "string",
15        "type": "TRIGGER",
16        "next": [
17          {
18            "step": "parse"
19          }
20        ]
21      }
22    ],
23    "createdAt": "2024-03-21T16:45:00Z"
24  }
25}
Get details of a workflow, including its draft version and steps.
Was this page helpful?
Previous

Update Workflow

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired
The ID of the workflow.

Headers

x-extend-api-version"2026-02-09"OptionalDefaults to 2026-02-09
API version to use for the request. If you're using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a `400 Bad Request` or be set to a previous legacy version. See [API Versioning](https://docs.extend.ai/2026-02-09/api-reference/api-versioning) for more details.

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

API version to use for the request. If you’re using an SDK, you can ignore this parameter. If you are not using an SDK and do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.