Skip to content
Proud to collaborate with Microsoft for Startups

schedule.list ​

List recurring schedules for an organization

List recurring schedules for an org (newest first).

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-composition
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
active_onlybooleanNoFalse—
activebooleanNo—Exact active-state filter; takes precedence over active_only
schedule_uuiduuidNo—Exact schedule UUID filter
namestringNo—Exact schedule name filter
target_workflow_typestringNo—Exact target workflow type filter
limitintegerNo50—

Output Schema ​

FieldTypeRequiredDefaultDescription
scheduleslistYes——
countintegerYes——
failure_reasonstringNo—Engine-stamped human-readable failure reason
failure_typestringNo—Engine-stamped failure category
failed_actionstringNo—Engine-stamped action method that raised
failed_at_statestringNo—Engine-stamped state when the workflow failed
failed_stepstringNo—Engine-stamped DAG step that failed
failed_layerstringNo—Engine-stamped DAG layer that failed
errorstringNo—Engine-stamped exception message
error_typestringNo—Engine-stamped exception class name

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "schedule.list",
  "initial_data": {
    "organization_uuid": "value"
  }
}