List Schedules

Overview

Returns a paginated list of all schedules — both DECLARATIVE schedules (defined in code with the cron option on schedules.task) and IMPERATIVE schedules (created via the dashboard or schedules.create()).

Authentication with a secret key is required.

Endpoint

GET https://api.trigger.dev/api/v1/schedules

Query parameters

integer

Page number (1-based). Defaults to 1.

integer

Number of schedules per page. Defaults to 20.

Response

object[]

Array of schedule objects.

Show Schedule object fields

string

Schedule ID, prefixed with sched_.

string

The task identifier this schedule triggers.

string

DECLARATIVE or IMPERATIVE.

boolean

Whether the schedule is currently active.

string

Deduplication key, if set.

string

External ID, if set (e.g. a user or org ID).

object

CRON generator info.

Show generator fields

string

Always CRON.

string

The CRON expression, e.g. 0 0 * * *.

string

Human-readable description, e.g. Every day at midnight.

string

IANA timezone for the schedule, e.g. America/New_York. Defaults to UTC.

string

ISO 8601 timestamp of the next scheduled run.

object[]

Environments this schedule is active in.

object

Show pagination fields

integer

Current page number.

integer

Total number of pages.

integer

Total number of schedules.

Examples

import { schedules } from "@trigger.dev/sdk";

const result = await schedules.list();

for (const schedule of result.data) {
  console.log(
    schedule.id,
    schedule.task,
    schedule.generator.expression,
    schedule.active
  );
}

import { schedules } from "@trigger.dev/sdk";

const result = await schedules.list({ page: 1, perPage: 50 });

console.log(`Page ${result.pagination.currentPage} of ${result.pagination.totalPages}`);

curl "https://api.trigger.dev/api/v1/schedules?page=1&perPage=20" \
  -H "Authorization: Bearer tr_dev_1234"

Response example

{
  "data": [
    {
      "id": "sched_1234",
      "task": "my-scheduled-task",
      "type": "IMPERATIVE",
      "active": true,
      "deduplicationKey": "daily-report",
      "externalId": "user_5678",
      "generator": {
        "type": "CRON",
        "expression": "0 9 * * 1-5",
        "description": "Every weekday at 9am"
      },
      "timezone": "America/New_York",
      "nextRun": "2024-04-02T13:00:00Z",
      "environments": [
        { "id": "cl1234", "type": "PRODUCTION" }
      ]
    }
  ],
  "pagination": {
    "currentPage": 1,
    "totalPages": 3,
    "count": 57
  }
}

Overview

Tasks & Runs

Schedules & Queues

Waitpoints & Env Vars

Overview

Endpoint

Query parameters

Response

Examples

Response example

​Overview

​Endpoint

​Query parameters

​Response

​Examples

​Response example

Overview

Endpoint

Query parameters

Response

Examples

Response example