Count a workflow’s waiting runs
GET/
Counts a workflow’s runs waiting in line that haven’t started.
Needs an API token with the Read permission for runs (run:read).
Parameters
Path
idRequired · UUIDThe workflow’s ID.
Before you unpublish
Unpublishing leaves waiting runs in line. Ask this first, and offer to cancel them too.
Responses
- 200OK
The count: exactly what Cancel waiting runs would cancel now.
idisn’t a UUID.- 403
FORBIDDENThe token lacks the Read permission for runs.
- 404
NOT_FOUNDNo workflow with this ID in the token’s workspace.
The count failed. Try again.
Any call can also answer: 401 UNAUTHORIZED · 401 TOKEN_ENDED · 403 TOKEN_SURFACE_OFF · 403 FEATURE_OFF · 403 EMBED_NOT_ALLOWED · 403 EMBED_NOT_AVAILABLE · 403 ACCOUNT_SUSPENDED · 429 RATE_LIMITED · 503 BUSY · 503 PAUSED · 503 SERVICE_UNAVAILABLE. See Errors.
Request
GORUNNER="https://api.gorunner.io"
GORUNNER_TOKEN="grt_…" # needs Read for runs
WORKFLOW_ID="your-workflow-id"
curl "$GORUNNER/api/workflows/$WORKFLOW_ID/runs/waiting" \
-H "Authorization: Bearer $GORUNNER_TOKEN"const GORUNNER = "https://api.gorunner.io";
const TOKEN = process.env.GORUNNER_TOKEN;
const WORKFLOW_ID = process.env.WORKFLOW_ID;
const res = await fetch(
`${GORUNNER}/api/workflows/${WORKFLOW_ID}/` +
`runs/waiting`,
{
headers: { Authorization: `Bearer ${TOKEN}` },
},
);
const { data } = await res.json();import os, requests
GORUNNER = "https://api.gorunner.io"
TOKEN = os.environ["GORUNNER_TOKEN"]
WORKFLOW_ID = os.environ["WORKFLOW_ID"]
res = requests.get(
f"{GORUNNER}/api/workflows/{WORKFLOW_ID}/runs/"
f"waiting",
headers={"Authorization": f"Bearer {TOKEN}"},
)
data = res.json()["data"]Response · 200 OK
{
"data": {
"waiting": 5
}
}Every field
It takes no body.
Response · 200 OK
dataobjectwaitingintegerRuns waiting in the line that have not started.