Skip to main content
GET
/
workflows
/
{workflowId}
Get workflow
curl --request GET \
  --url https://script.so/api/v1/workflows/{workflowId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "wf_xyz789",
  "name": "Daily Sales Report",
  "description": "Generate and send daily sales summary",
  "status": "building",
  "job_id": "job_build_abc123",
  "steps": [
    {
      "id": "step_1",
      "description": "Fetch all orders from Shopify created in the last 24 hours",
      "status": "pending",
      "position": 1,
      "inputs": [
        "orders"
      ],
      "outputs": [
        "summary"
      ]
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authentication. Get your key from Settings → API Keys.

Use sk_live_ prefix for production, sk_test_ for development.

Path Parameters

​
workflowId
string
required

Workflow ID

Example:

"wf_xyz789"

Response

Workflow details

​
id
string
Example:

"wf_xyz789"

​
name
string
Example:

"Daily Sales Report"

​
description
string
Example:

"Generate and send daily sales summary"

​
status
enum<string>
  • building: Code generation in progress
  • ready: Workflow is ready to run
  • error: Build failed
Available options:
building,
ready,
error
​
job_id
string

Build job ID (only present when status is building)

Example:

"job_build_abc123"

​
steps
object[]
​
created_at
string<date-time>
​
updated_at
string<date-time>