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 ID: getJob

Authentication

Option 1

• BearerAuth (http bearer) API key token. Create via POST /api/api-keys. Format: envoy_<hex>

Option 2

• CookieAuth (apiKey) Session cookie set after login + TOTP verification

Path parameters

• id — integer, required Resource ID

Success responses

200

Job with resolved details

Content type: application/json

• Type: Job & object
• All of:
  • Variant 1:
    • Reference: Job
      • Type: object
      • Properties:
        • id (integer)
        • job_template_id (integer)
        • name (string)
        • description (string | null)
          • Nullable: yes
        • connector_mapping (string) — JSON-encoded map of template connector name to connector ID
        • status (string)
          • Allowed values: active, archived
        • overridden_task_keys (array<string>) — DAG node keys with a per-job task YAML override. Present on GET detail.
          • Description: DAG node keys with a per-job task YAML override. Present on GET detail.
          • Items:
            • Type: string
        • created_at (string)
          • Format: date-time
        • updated_at (string)
          • Format: date-time
  • Variant 2:
    • Type: object
    • Properties:
      • connector_mapping (object)
        • Additional properties:
          • Type: integer
      • resolved_connectors (object)
        • Additional properties:
          • Type: object
          • Properties:
            • id (integer)
            • name (string)
            • type (string)
      • template_name (string | null)
        • Nullable: yes
      • dag (object | null)
        • Nullable: yes

Error responses

404

Resource not found

Content type: application/json

• Reference: Error
  • Type: object
  • Properties:
    • error (string)
      • Example: NOT_FOUND
    • message (string)
      • Example: Resource not found

Example:

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

Examples

cURL

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

JavaScript (fetch)

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);