API Reference

List jobs for a template

View Markdown

GET /api/job-templates/{id}/jobs

Operation IDlistJobTemplateJobs

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

Success response body

200Paginated list of jobs

Paginated list of jobs

Content typeapplication/json

responseobject

4 properties

resultarray<Job>required

Array items

itemobject

9 properties

idinteger

job_template_idinteger

namestring

descriptionstring | null

Nullable: yes

connector_mappingstring

JSON-encoded map of template connector name to connector ID

statusstring

Allowed values: active, archived

overridden_task_keysarray<string>

DAG node keys with a per-job task YAML override. Present on GET detail.

Array items

itemstring

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/job-templates/YOUR_ID/jobs?cursor=YOUR_CURSOR&limit=50' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/job-templates/YOUR_ID/jobs?cursor=YOUR_CURSOR&limit=50", {
  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);