Retrieve Schedule

Get a schedule by its ID.

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

id

string

The unique ID of the schedule, prefixed with 'sched_'

Example:

"sched_1234"

task

string

The id of the scheduled task that will be triggered by this schedule

Example:

"my-scheduled-task"

active

boolean

Whether the schedule is active or not

Example:

true

deduplicationKey

string

The deduplication key used to prevent creating duplicate schedules

Example:

"dedup_key_1234"

externalId

string

The external ID of the schedule. Can be anything that is useful to you (e.g., user ID, org ID, etc.)

Example:

"user_1234"

generator

object

Show child attributes

generator.type

enum<string>

Available options:

CRON

generator.expression

string

The cron expression used to generate the schedule

Example:

"0 0 * * *"

generator.description

string

The description of the generator in plain english

Example:

"Every day at midnight"

nextRun

string

The next time the schedule will run

Example:

"2024-04-01T00:00:00Z"

environments

object[]

Show child attributes

environments.id

string

environments.type

string

environments.userName

string