Skip to main content

List cycles for a project

GET 
/api/projects/:id/cycles

List cycles for a project. In the default (raw-row) mode archived cycles are excluded unless ?includeArchived=true. ?summary=1 returns the enriched list read model (progress + burndown trend + velocity per cycle) and always excludes archived cycles. In that mode PROGRESS IS LIVE ONLY WHILE A CYCLE IS PLANNED OR ACTIVE (PT-917): a completed cycle reports its frozen close snapshot, described by progress.source and progress.measurement — and every counter is null when that measurement is "unavailable", i.e. the close snapshot is missing or unusable (a non-finite stored counter). A completed cycle also carries restatedVelocity (PT-1108), its completed work restated at current estimates beside the frozen velocity. ?options=1 (PT-679) returns the SLIM cycle-options list (id / name / owner — every row on this project-scoped endpoint has owner.kind === "project") for the Tasks-page Cycle filter chip — scoped to this project, without the per-cycle progress/burndown computation, and also always excludes archived cycles. includeArchived applies to the raw-row mode only (ignored in both summary and options modes). ?settings=1 (PT-1104) returns the cycle mode of the PROJECT’s organisation — what the create dialog needs when it opens on a project the caller reaches from another organisation. Mode precedence when flags are combined: settings=1 wins over options=1, which wins over summary=1, which wins over the raw list.

Request​

Responses​

Successful response