user-states

Get Week View

Assembly of the rolling plan view.

Returns past boards (up to 6 days), today's board, and intents for future days (up to 6 days). If no WeeklyPlan exists for the user, creates a trigger="pending" placeholder and enqueues a background generation — the response comes back immediately with plan_trigger="pending" so the client can poll until the real plan is ready. Concurrent calls while pending do not re-enqueue: the placeholder short-circuits the current_plan is None check. The local plan lifecycle always runs; a runtime flag may substitute a fully validated Cheshire weekly view only during response assembly.

get/user_states/week

Query parameters

latitudenumber nullable

longitudenumber nullable

timezonestring nullable

now_isostring nullable

user_idstring nullable

Headers

accept-languagestring nullable

x-device-timezonestring nullable

x-unitsstring nullable

Response

Successful Response

plan_generated_atstring required

ISO timestamp from Cheshire when its envelope supplies one; otherwise the active legacy plan timestamp.

plan_triggerstring required

Legacy plan lifecycle trigger; unchanged by read source.

phasestring nullable required

Phase from the selected Cheshire or legacy plan source.

plan_source'legacy' | 'cheshire' required

cheshire only when its complete view passed every safety gate; legacy for disabled, shadow, out-of-cohort, or fallback reads.

Changes

No recorded changes to this endpoint across all 1 revision of this API.