API Reference
See the full request/response schema and parameters in the API Reference.
Schedule definition
A schedule binds aworkflow_id to a cron_expression and timezone:
workflow_id— the workflow to run. It must exist in your organization.name— required, up to 120 characters.cron_expression— standard 5-field cron (minute hour day month weekday). An invalid expression or timezone returns400.timezone— IANA timezone, e.g.America/Los_Angeles. Defaults toUTC.description— optional free-form text.is_active— defaults totrue. Set tofalseto save a schedule without activating it.
disabled_reason on the response.
Create schedule
Create a new schedule for a workflow.workflow_id, name, and cron_expression. Returns 201 with the schedule, including up to three upcoming next_run_times.
Example request
Example response
List schedules
Retrieve the schedules of your active team.workflow_id — filter to schedules for a single workflow.
Get schedule
Retrieve a single schedule by ID.Update schedule
Update a schedule’s name, cadence, timezone, description, or active state.name, cron_expression, timezone, description, is_active) are optional — only include what you want to change.
Reactivating a paused schedule rebinds its execution identity to the current user or API key and clears
disabled_reason. The schedule remains owned by its team.Example request
Delete schedule
Permanently delete a schedule. Returns{"success": true, "id": "SCHEDULE_ID"}.
Deleting a schedule does not affect the underlying workflow or its run history.