Skip to content
Proud to collaborate with Microsoft for Startups

schedule.get ​

Fetch one recurring schedule by UUID

Fetch one recurring schedule by UUID.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-composition
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes——
schedule_uuiduuidYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
scheduledictYes——
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.get",
  "initial_data": {
    "organization_uuid": "value",
    "schedule_uuid": "value"
  }
}