API Reference

Get a job

GET /api/jobs/{id}

Returns the job with resolved connector info, template name, and DAG. The DAG is derived from the job's snapshotted template YAML (captured at job creation time), not the live template.

Operation IDgetJob

Authentication

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

Path parameters

idintegerrequired

Resource ID

Success response body

200Job with resolved details

Job with resolved details

Content typeapplication/json

responseobject

12 properties

idinteger

job_template_idinteger

namestring

descriptionstring | null

Nullable: yes

connector_mappingobject

Additional properties

valueinteger

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

resolved_connectorsobject

Additional properties

valueobject

3 properties

idinteger

namestring

typestring

template_namestring | null

Nullable: yes

dagobject | null

Nullable: yes

Error responses

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/jobs/YOUR_ID' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/jobs/YOUR_ID", {
  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);