API Reference

List runs for a job

View Markdown

GET /api/jobs/{id}/runs

List runs for a job

Operation IDlistJobRuns

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Query parameters

cursorstring

Pagination cursor from a previous response

limitinteger

Maximum number of results to return

Default: 50
Maximum: 200

statusstring

Allowed values: pending, running, paused, completed, success, failed, cancelled

Success response body

200Paginated list of job runs

Paginated list of job runs

Content typeapplication/json

responseobject

4 properties

resultarray<JobRun>required

Array items

itemobject

12 properties

idinteger

job_idinteger

statusstring

Allowed values: pending, running, paused, completed, failed, cancelled

started_atstring | null · date-time

Nullable: yes

completed_atstring | null · date-time

Nullable: yes

duration_msinteger | null

Nullable: yes

error_messagestring | null

Nullable: yes

selected_tasksstring | null

JSON-encoded array of task keys to run (null = all)

Nullable: yes

run_statestring | null

Internal DAG execution state (JSON)

Nullable: yes

skip_depsinteger | null

1 when selected tasks should run without their upstream depends_on tasks; 0/null otherwise.

Nullable: yes

created_atstring · date-time

updated_atstring · date-time

nextCursorstring

prevCursorstring

totalinteger

Total number of records matching the current filters

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/jobs/YOUR_ID/runs?cursor=YOUR_CURSOR&limit=50&status=pending' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/jobs/YOUR_ID/runs?cursor=YOUR_CURSOR&limit=50&status=pending", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);