Skip to main content
GET
/
batches
/
{batchId}
Get batch status
curl --request GET \
  --url https://script.so/api/v1/batches/{batchId} \
  --header 'Authorization: Bearer <token>'
{
  "batch_id": "batch_xyz789",
  "workflow_id": "wf_xyz789",
  "status": "pending",
  "total": 3,
  "completed": 3,
  "failed": 0,
  "executions": [
    {
      "execution_id": "<string>",
      "inputs": {},
      "status": "<string>",
      "duration_ms": 123
    }
  ],
  "started_at": "2023-11-07T05:31:56Z",
  "completed_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

​
batchId
string
required

Batch ID

Example:

"batch_xyz789"

Response

Batch status

​
batch_id
string
Example:

"batch_xyz789"

​
workflow_id
string
Example:

"wf_xyz789"

​
status
enum<string>
Available options:
pending,
running,
completed,
failed
​
total
integer
Example:

3

​
completed
integer
Example:

3

​
failed
integer
Example:

0

​
executions
object[]
​
started_at
string<date-time>
​
completed_at
string<date-time>