API Reference

List triggers

View Markdown

GET /api/triggers

List triggers

Operation IDlistTriggers

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

job_idinteger

Filter by job ID

Success response body

200Paginated list of triggers

Paginated list of triggers

Content typeapplication/json

responseobject

4 properties

resultarray<Trigger>required

Array items

itemobject

10 properties

idinteger

job_idinteger

task_keystring | null

Nullable: yes

typestring

cron repeats on a cron expression; one_off fires once at the datetime in cron_expression then auto-disables.

Allowed values: cron, one_off

cron_expressionstring | null

5-field cron expression for type=cron; ISO-8601 datetime (UTC) for type=one_off.

Nullable: yes

argumentsstring | null

JSON-encoded arguments

Nullable: yes

enabledinteger

Allowed values: 0, 1

last_triggered_atstring | null · date-time

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/triggers?cursor=YOUR_CURSOR&limit=50&sort=YOUR_SORT&order=desc&job_id=YOUR_JOB_ID' \
  --header 'Authorization: Bearer $API_KEY'

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