Operating system set to macOS
Documentation jurisdiction set to United States
Sign inConnect Claude
API/schemas
Schema

Workplan

Workplan response model. OpenAPI title is ``Workplan``; the Python class name stays ``BlueprintResponse``.

FieldTypeDescription
idrequiredstring (uuid)Workplan UUID
template_idrequiredstring (uuid)Source template UUID (workstream_id in DB)
namerequiredstringWorkplan name
client_idstring (uuid) | nullClient UUID (optional)
client_namestring | nullClient name
run_modeWorkplanRunModeThe WorkPlan's effective run posture (S2-READ §1a). ``effective`` resolves: plan-level ``configuration.run_mode`` → the workstream default → ``propose``. ``source`` tells the FE whether the value was set on this plan or inherited. ``locked`` is the firm-lock governance flag — always ``False`` in S2.
show nested
cohortWorkplanCohortStructural facts about the WorkPlan's bound client set (S2-READ §1b). Live exception/ready counts live on the roster's ``summary`` (one authoritative source); this object carries only the cohort's size + shape. With no multi-client cohort writer yet, ``total_clients`` resolves to 0/1 and ``selector_kind`` to ``single`` — the shape is frozen, the populating data is S2-write BE work behind it.
show nested
config_overridesobjectConfiguration (from DB)
show nested
Empty object.
effective_configobjectMerged effective config
show nested
Empty object.
schedulestring | nullCron schedule expression (from configuration; null = unscheduled)
schedule_timezonestringIANA timezone for the schedule (from configuration; defaults UTC)
max_duration_minutesinteger | nullPer-instance duration guardrail in minutes (from configuration; null = unset)
human_checkpointsany[]Sign-off gate checkpoints (from configuration). Non-empty means a partner sign-off gate is on.
statusrequired"draft" | "active" | "paused" | "archived"Status for workstream entities.
draftactivepausedarchived
last_run_atstring (date-time) | nullMost recent cycle start for this WorkPlan (null if never run)
next_run_atstring (date-time) | nullNext scheduled execution — computed; see GET /workplans/{id}/next-run (P1)
created_bystring (uuid) | nullCreator user ID (owner_id in DB)
created_atrequiredstring (date-time)Creation timestamp
updated_atrequiredstring (date-time)Last update timestamp