List Schedules

List all schedules.

Authorizations

Authorization

string

header

required

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

Query Parameters

page

integer

Page number of the schedule listing

perPage

integer

Number of schedules per page

Response

200 - application/json

data

object[]

Show child attributes

data.active

boolean

Whether the schedule is active or not

data.deduplicationKey

string

The deduplication key used to prevent creating duplicate schedules

data.environments

object[]

Show child attributes

data.environments.id

string

data.environments.type

string

data.environments.userName

string

data.externalId

string

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

data.generator

object

Show child attributes

data.generator.description

string

The description of the generator in plain english

data.generator.expression

string

The cron expression used to generate the schedule

data.generator.type

enum<string>

Available options:

CRON

data.id

string

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

data.nextRun

string

The next time the schedule will run

data.task

string

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

pagination

object

Show child attributes

pagination.count

integer

pagination.currentPage

integer

pagination.totalPages

integer