API Reference

List runs

View Markdown

GET /api/runs

List runs

Operation IDlistRuns

Authentication

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

Query parameters

cursorstring

Pagination cursor from a previous response

limitinteger

Maximum number of results to return

Default: 50
Maximum: 200

sortstring

Column name to sort by (validated per-entity)

orderstring

Sort direction

Default: desc
Allowed values: asc, desc

task_idinteger

Filter by task ID

statusstring

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

Success response body

200Paginated list of runs

Paginated list of runs

Content typeapplication/json

responseobject

4 properties

resultarray<Run>required

Array items

itemobject

16 properties

idinteger

task_idinteger

task_versioninteger

trigger_typestring

Allowed values: manual, cron, api

statusstring

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

argumentsstring | null

JSON-encoded arguments

Nullable: yes

connector_mappingstring | null

JSON-encoded map of connector slot name to connector ID

Nullable: yes

started_atstring | null · date-time

Nullable: yes

completed_atstring | null · date-time

Nullable: yes

duration_msinteger | null

Nullable: yes

item_countinteger | null

Nullable: yes

error_messagestring | null

Nullable: yes

log_filestring | null

Nullable: yes

metrics_summarystring | null

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/runs?cursor=YOUR_CURSOR&limit=50&sort=YOUR_SORT&order=desc&task_id=YOUR_TASK_ID&status=pending' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/runs?cursor=YOUR_CURSOR&limit=50&sort=YOUR_SORT&order=desc&task_id=YOUR_TASK_ID&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);