List schedules
well_list_schedulesList this workspace's schedules, newest first, each with its last 5 runs.
OPTIONAL: status (a list of "draft", "active", "paused", "completed", "cancelled"; omit it for every status). OPTIONAL: month ("YYYY-MM"): the calendar month a routine calendar reads, any month past or future; omit it for the next 62 days from now instead. Either way, upcoming_runs (in _meta) carries each clock routine's occurrence dates for the window, keyed by schedule_id, and capped_schedule_ids (in _meta) names every routine whose dates in that window were cut short by its own occurrence cap — say the calendar could not show every date for that routine, never that it has none.
Each schedule carries its name, kind, routine_summary and cadence_label (the words to say to the user), status_report (none, on_error, on_success or both: when Well sends a message after a run), instruction or method (the run's brief, never shown to the user; a morning brief that follows Well's own brief has instruction null, instruction_owner "well" and a sections list naming the pieces Well's brief carries, and is never compared with the person's words), when it runs (cron_expression and its timezone, or trigger_name; an event routine has no timezone), run_after, max_occurrences, ends_at (the moment after which the routine stops, or null for no end), approved_tools, status, next_run_at, consecutive_failures, paused_reason, report_destination, purpose (the job it does when it has a named one, such as weekly_missing_invoices_total), preset (null for a routine a member asked for, or the default routine Well created it from, such as weekly_missing_invoices_total), is_mine (true when the routine is the caller's own: they created it, or Well set it up for them), may_change (whether the caller may change, arm, pause, resume or cancel it: a routine runs as its creator, so only its creator or a workspace admin may), change_takes_over (true when a change by the caller, an admin, makes the routine theirs: it then runs as them and waits for their own yes) and recent_runs. report_destination says where the routine's report is expected to go: "whatsapp", "email" or "slack" (a direct message from Well in the creator's own Slack), from its creator's communication preference, or, when the creator set no preference, the report kind's default channel; null when the routine reports nothing. It is a prediction: a channel that cannot reach the creator at send time still falls back to email. Each run carries its status, summary, warning_message, skip_reason and the thread it ran in. A run of another member's morning brief carries its status and no summary, warning_message or thread: that brief is theirs alone. A skipped run with skip_reason "sunday" is a clock routine Well held back on a Sunday in the user's time zone: say it was skipped for Sunday, not that it failed. A skipped run with skip_reason "in_morning_brief" sent no message of its own because the user's morning brief already carries what it reports: say so, not that it failed. A skipped run with skip_reason "in_other_login_brief" is a morning brief Well held back because the brief of the user's other Well account on the same WhatsApp number already covers these workspaces: say one brief covers both, not that it failed. A skipped run with skip_reason "no_reachable_channel" did not run because no channel reaches the user in the order their preference sets (no WhatsApp conversation and no email, or an email preference with no email): say they get the brief once they link WhatsApp, add an email or change that preference, not that it failed. A skipped run with skip_reason "already_sent_today" is a morning brief that already went out that day: say the day's brief was sent, not that it failed. A trigger routine has a trigger_name and never a next_run_at. A draft, a paused or a cancelled schedule has no next_run_at. The list is capped, and truncated says when more exist.
A one-off at a set time shows max_occurrences 1 and completes after its run; a routine with an ends_at completes once that moment passes and draws no date after it; a recurring job shows a cron_expression with no max_occurrences. Use it to find a schedule before changing or cancelling it (a routine with a purpose is found by its purpose and is_mine, never by its text; another member's routine is never the caller's), and to answer what is scheduled, what reminders or timed jobs the user has and how the last runs went. Quote what it returns; never state a status it did not report. Describe a routine to the user by its routine_summary and cadence_label, and by next_run_at only when it is enabled. A disabled morning brief keeps its current status, but its runs skip with skip_reason "disabled" and send nothing; say it is off and can be turned back on. Never use its instruction, cron_expression or trigger_name.
Do NOT use this to create or change a schedule (use well_create_schedule and well_update_schedule).
When the token authorizes one workspace, call this directly — no workspace call is needed first. When it authorizes several, this read will not guess which one you mean: pass workspace_id on the call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| month | No | The calendar month a routine calendar reads, as "YYYY-MM". Any month, past or future. | |
| status | No | Only the schedules in these statuses. | |
| workspace_id | No | Target workspace. Omit when the token authorizes one workspace. Required when it authorizes several: this read reports one workspace's own figures and will not choose which. | |
| conversation_id | No | The conversation id returned by the previous Well result, in its meta under well/conversation_id, in its structuredContent, or in its JSON text block. Pass it back on every call in the same conversation, including a call a card makes, so the chosen workspace and the earlier answers still apply. It decides the conversation on its own: nothing the host states about the session replaces it. Omit it only on the first call of a conversation. | |
| workspace_scope | No | Restrict this call to the family: the token's primary workspace plus the company workspaces under it that you are a member of. Unrelated authorized workspaces drop out of the read; row reads merge across the family, while a per-workspace figure still reports exactly one workspace. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| status | No | ||
| message | No | ||
| success | Yes | ||
| schedule | No | ||
| schedules | No | ||
| truncated | No | ||
| next_run_at | No | ||
| approved_tools | No | ||
| conversation_id | No | The conversation this result belongs to. Pass it back as the conversation_id argument on every later Well call in the same conversation. | |
| newly_connected | No | Tools that connected to this workspace since the last result and that no session was told about yet, oldest first. Present only when at least one tool is new. The connected-line rule says when to tell an entry; when it does, one line per entry, in the person's language: "<name> is connected.". Never fold several entries into one sentence. Each entry comes back once, on one result only: never repeat its line later. | |
| resolved_workspace | No | The workspace that answered, when the caller named none and the token authorizes several. | |
| conversation_id_note | No | Present only when the server opened a fresh lane, stating that no choice recorded earlier was read. | |
| conversation_id_source | No | Where the conversation id came from: the host's own request meta, the caller's argument, or a fresh lane the server opened. |