Schedules

Schedules run an activity on a recurring cadence, such as starting a task every hour. Create, edit, preview and run them, and read each schedule's run history.

📄️List schedules

Lists the organization's schedules by name, each with its next fire time, last outcome and health. Requires the Org Owner or Org Admin role.

📄️Create schedule

Creates a schedule that runs an activity on a cron expression or fixed interval and returns it. Activities that cannot be scheduled, projects outside the organization and a schedule faster than the organization's minimum interval return 422. Requires the Org Owner or Org Admin role.

📄️List activity types

Lists the activities a schedule can run, with their parameters, default schedule, minimum gap and whether a new schedule may use them, plus the accepted interval lengths. Requires the Org Owner or Org Admin role.

📄️Move schedule folder

Moves a schedule folder by renaming every schedule beneath it in one step: `a/b/x` moved to `c` becomes `c/b/x`, and returns the number moved. When `ids` do not match the schedules under the folder, or a new name clashes with an existing schedule, nothing moves and 409 returns. Requires the Org Owner or Org Admin role.

📄️Preview schedule

Describes an unsaved schedule in words and returns its next fire times and time zone. Saves nothing and rejects a malformed schedule as a save would. Requires the Org Owner or Org Admin role.

📄️List all schedule runs

Lists firings across all schedules, newest first, one page at a time; `limit` is at most 200, and `next_before` is passed as `before` for the next page. Filters by schedule and outcome, and also returns the schedules and outcomes available as filters. Requires the Org Owner or Org Admin role.

📄️Delete schedule

Deletes a schedule and its run history. Requires the Org Owner or Org Admin role. Returns 204 with no body.

📄️Get schedule

Returns one schedule with its activity, parameters, timing limits, retention mode, time zone and consecutive skip count. Requires the Org Owner or Org Admin role.

📄️Update schedule

Changes only the fields sent on a schedule and returns it; a new timing faster than the organization's minimum interval returns 422. Disabling pauses it; re-enabling restarts its cadence from now without replaying missed firings. Requires the Org Owner or Org Admin role.

📄️Run schedule now

Fires a schedule once, outside its cadence, and returns whether a firing was queued. Returns 409 if the schedule is disabled or has no minimum gap. Requires the Org Owner or Org Admin role.

📄️List schedule runs

Lists one schedule's firings, newest first, one page at a time, each with its outcome, timing and any task it created. Pass `next_before` as `before` for the next page; `limit` is at most 200. Requires the Org Owner or Org Admin role.