---
title: "get schedule"
method: GET
path: "/w/{workspace}/schedules/get/{path}"
tags: ["schedule"]
---

# get schedule

`GET /w/{workspace}/schedules/get/{path}`

## Path parameters

- `workspace` string, required
- `path` string, required

## Query parameters

- `get_draft` boolean

## Response `200`

schedule deleted

- object — Overlay fields added to every "get by path" response that accepts the `get_draft` query parameter. The deployed payload is sent untouched in the response body; the authed user's saved draft for this path — whatever shape the editor wrote — is attached as the sibling `draft` field when `get_draft=true` and a draft exists. The frontend pairs the two to present diff / reset / discard UI; the server never merges them. When `no_deployed=true` there is no deployed row at this path — the response body is a best-effort stand-in synthesized from the draft, and only `draft` is canonical. Callers should disable "diff vs deployed" UI in that case.
  - `path` string, required — The unique Windmill path for this schedule. Must be of the form `u/<user>/<path>` or `f/<folder>/<path>`.
  - `edited_by` string, required — Username of the last person who edited this schedule
  - `edited_at` string, date-time, required — Timestamp of the last edit
  - `schedule` string, required — Cron expression with 6 fields (seconds, minutes, hours, day of month, month, day of week). Example '0 0 12 * * *' for daily at noon
  - `timezone` string, required — IANA timezone for the schedule (e.g., 'UTC', 'Europe/Paris', 'America/New_York')
  - `enabled` boolean, required — Whether the schedule is currently active and will trigger jobs
  - `script_path` string, required — Path to the script or flow to execute when triggered
  - `is_flow` boolean, required — True if script_path points to a flow, false if it points to a script
  - `args` ScriptArgs — The arguments to pass to the script or flow
  - `extra_perms` object, required — Additional permissions for this schedule
  - `email` string, required — Email of the user who owns this schedule, used for permissioned_as
  - `permissioned_as` string, required — The user or group this schedule runs as (e.g., 'u/admin' or 'g/mygroup')
  - `error` string, nullable — Last error message if the schedule failed to trigger
  - `on_failure` string, nullable — Path to a script or flow to run when the scheduled job fails
  - `on_failure_times` number, nullable — Number of consecutive failures before the on_failure handler is triggered (default 1)
  - `on_failure_exact` boolean, nullable — If true, trigger on_failure handler only on exactly N failures, not on every failure after N
  - `on_failure_extra_args` ScriptArgs — The arguments to pass to the script or flow
  - `on_recovery` string, nullable — Path to a script or flow to run when the schedule recovers after failures
  - `on_recovery_times` number, nullable — Number of consecutive successes before the on_recovery handler is triggered (default 1)
  - `on_recovery_extra_args` ScriptArgs — The arguments to pass to the script or flow
  - `on_success` string, nullable — Path to a script or flow to run after each successful execution
  - `on_success_extra_args` ScriptArgs — The arguments to pass to the script or flow
  - `ws_error_handler_muted` boolean — If true, the workspace-level error handler will not be triggered for this schedule's failures
  - `retry` Retry — unresolved $ref
  - `summary` string, nullable — Short summary describing the purpose of this schedule
  - `description` string, nullable — Detailed description of what this schedule does
  - `no_flow_overlap` boolean — If true, skip this schedule's execution if the previous run is still in progress (prevents concurrent runs)
  - `tag` string, nullable — Worker tag to route jobs to specific worker groups
  - `paused_until` string, date-time, nullable — ISO 8601 datetime until which the schedule is paused. Schedule resumes automatically after this time
  - `cron_version` string, nullable — Cron parser version. Use 'v2' for extended syntax with additional features
  - `dynamic_skip` string, nullable — Path to a script that validates scheduled datetimes. Receives scheduled_for datetime and returns boolean to skip (true) or run (false)
  - `labels` string[]
  - `draft_only` boolean — True when this row is a per-user draft with no deployed schedule at the same path. Frontend renders a "Draft" badge.
  - `is_draft` boolean, required — True when the authed user has a per-user draft at this path (over a deployed row or a synthesized draft-only row). Frontend appends a `*` to the displayed name.
  - `inherited_labels` string[] — Labels inherited from the parent folder, computed at read time. Read-only — edit them on the folder.
  - `draft_saved_at` string, date-time
  - `no_deployed` boolean
  - `draft` object
  - `other_drafts_users` object[] — Other workspace users (and the legacy NULL-email row, if any) with a saved draft at the same path. Populated only on the authed user's "get by path" responses for kinds the editor surfaces a fork banner for (script, flow, app, raw_app). Empty / omitted for kinds without that UI.
    - `username` string, nullable — Workspace username of the draft owner. `null` represents the legacy workspace-level (NULL-email) row. Emails never leave the server.
    - `draft_saved_at` string, date-time, required — When this user's draft was last saved (`draft.created_at`), surfaced in the fork modal as "Last updated".

---

[API](https://skmtc.net/windmill/apis/windmill-api.md) · [All operations](https://skmtc.net/windmill/apis/windmill-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/windmill/windmill-api/revisions/8c5a46218b05/schema)