Start typing to search.

API Reference

List tasks in a job run

View Markdown

List tasks in a job run

GET /api/job-runs/{id}/tasks

List tasks in a job run

Operation ID: listJobRunTasks

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

  • idinteger, required Resource ID

Success responses

200

List of job run tasks (max 200)

Content type: application/json

  • Reference: PaginatedResult
    • Type: object
    • Properties:
      • result (array<unknown>)
        • Items:
          • Type: unknown
      • nextCursor (string | null)
        • Nullable: yes
      • prevCursor (string | null)
        • Nullable: yes
      • total (integer) — Total number of records matching the current filters

Examples

cURL

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

JavaScript (fetch)

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