Skip to main content
GET
Retrieve a schedule
Retrieves one schedule. Returns the schedule object.

Path parameters

string
required
The schedule’s id (UUID).

Response

The schedule object, also returned by create, list, update, pause, and resume.
string
Unique id (UUID).
string
Display name.
string | null
Optional description.
object
When the schedule fires: type ("cron"), expression (five-field cron), and timezone (IANA name the expression is evaluated in).
object
Template used to create each scheduled session, in the Create session body shape. Re-resolved on every fire.
boolean
Whether the schedule is paused. Paused schedules do not fire automatically but can still be triggered.
string | null
Why the schedule is paused: the note passed to Pause, an explanatory note when it was paused automatically after repeated failures, or a note that it became inactive after creating its repeats sessions.
integer | null
How many sessions to create before the schedule becomes inactive. null means it runs until paused or deleted.
integer
Automatic fires that created a session. Skipped fires, errors, and manual triggers are not counted. When this reaches repeats, the schedule is paused.
string[]
The next 5 fire times (UTC, RFC 3339). Empty while paused.
string | null
When the schedule last fired automatically. Manual triggers do not update it.
string
When the schedule was created.
string
When the schedule was last modified.

Examples

Response

Errors