GET
/
api
/
v1
/
schedules
import { schedules } from "@trigger.dev/sdk/v3";

const allSchedules = await schedules.list();
{
  "data": [
    {
      "id": "sched_1234",
      "task": "my-scheduled-task",
      "type": "IMPERATIVE",
      "active": true,
      "deduplicationKey": "dedup_key_1234",
      "externalId": "user_1234",
      "generator": {
        "type": "CRON",
        "expression": "0 0 * * *",
        "description": "Every day at midnight"
      },
      "timezone": "America/New_York",
      "nextRun": "2024-04-01T00:00:00Z",
      "environments": [
        {
          "id": "<string>",
          "type": "<string>",
          "userName": "<string>"
        }
      ]
    }
  ],
  "pagination": {
    "currentPage": 123,
    "totalPages": 123,
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Use your project-specific Secret API key. Will start with tr_dev_, tr_prod, tr_stg, etc.

You can find your Secret API key in the API Keys section of your Trigger.dev project dashboard.

Our TypeScript SDK will default to using the value of the TRIGGER_SECRET_KEY environment variable if it is set. If you are using the SDK in a different environment, you can set the key using the configure function.

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

configure({ accessToken: "tr_dev_1234" });

Query Parameters

​
page
integer

Page number of the schedule listing

​
perPage
integer

Number of schedules per page

Response

200
application/json
Successful request
​
data
object[]
​
pagination
object

Was this page helpful?

Suggest editsRaise issue
Previous
Create Schedule
Next