schedule.list ​
List recurring schedules for an organization
List recurring schedules for an org (newest first).
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-composition |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
active_only | boolean | No | False | — |
active | boolean | No | — | Exact active-state filter; takes precedence over active_only |
schedule_uuid | uuid | No | — | Exact schedule UUID filter |
name | string | No | — | Exact schedule name filter |
target_workflow_type | string | No | — | Exact target workflow type filter |
limit | integer | No | 50 | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
schedules | list | Yes | — | — |
count | integer | Yes | — | — |
failure_reason | string | No | — | Engine-stamped human-readable failure reason |
failure_type | string | No | — | Engine-stamped failure category |
failed_action | string | No | — | Engine-stamped action method that raised |
failed_at_state | string | No | — | Engine-stamped state when the workflow failed |
failed_step | string | No | — | Engine-stamped DAG step that failed |
failed_layer | string | No | — | Engine-stamped DAG layer that failed |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
done | Yes | Yes | Yes | — | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "schedule.list",
"initial_data": {
"organization_uuid": "value"
}
}