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

const schedule = await schedules.retrieve(scheduleId);
{
  "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>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use your Secret API key in the form 'Bearer <SECRET KEY>' (without the quotation marks)

Path Parameters

​
schedule_id
string
required

The ID of the schedule.

Response

200
application/json

Successful request

The response is of type object.