Schedules API
List Schedules
Fundamentals
Development
Deployment
- Environment Variables
- CLI deploy command
- GitHub Actions
- Deployment integrations
Writing tasks
API reference
- Functions
- Objects
- CLI
- Runs API
- Schedules API
Architecture
Open source
Schedules API
List Schedules
List all schedules.
GET
/
api
/
v1
/
schedules
import { schedules } from "@trigger.dev/sdk/v3";
const allSchedules = await schedules.list();{
"data": [
{
"id": "sched_1234",
"task": "my-scheduled-task",
"active": true,
"deduplicationKey": "dedup_key_1234",
"externalId": "user_1234",
"generator": {
"type": "CRON",
"expression": "0 0 * * *",
"description": "Every day at midnight"
},
"nextRun": "2024-04-01T00:00:00Z",
"environments": [
{
"id": "<string>",
"type": "<string>",
"userName": "<string>"
}
]
}
],
"pagination": {
"currentPage": 123,
"totalPages": 123,
"count": 123
}
}Authorizations
Use your Secret API key in the form 'Bearer <SECRET KEY>' (without the quotation marks)
Query Parameters
Page number of the schedule listing
Number of schedules per page
Response
200
application/json
Successful request
The unique ID of the schedule, prefixed with 'sched_'
Example:
"sched_1234"
The id of the scheduled task that will be triggered by this schedule
Example:
"my-scheduled-task"
Whether the schedule is active or not
Example:
true
The deduplication key used to prevent creating duplicate schedules
Example:
"dedup_key_1234"
The external ID of the schedule. Can be anything that is useful to you (e.g., user ID, org ID, etc.)
Example:
"user_1234"
The next time the schedule will run
Example:
"2024-04-01T00:00:00Z"
Was this page helpful?
import { schedules } from "@trigger.dev/sdk/v3";
const allSchedules = await schedules.list();{
"data": [
{
"id": "sched_1234",
"task": "my-scheduled-task",
"active": true,
"deduplicationKey": "dedup_key_1234",
"externalId": "user_1234",
"generator": {
"type": "CRON",
"expression": "0 0 * * *",
"description": "Every day at midnight"
},
"nextRun": "2024-04-01T00:00:00Z",
"environments": [
{
"id": "<string>",
"type": "<string>",
"userName": "<string>"
}
]
}
],
"pagination": {
"currentPage": 123,
"totalPages": 123,
"count": 123
}
}