Playground

Playground

Sprint

/api/v1/edm-projects/sprints

A time-boxed iteration of work in a Project.

listgetcreateupdateclose

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
project_idstringParent project ID.
namestringHuman-readable sprint name.
week_keystringISO 8601 week identifier (e.g., '2026-W22').
start_datedate-timeSprint start date.
end_datedate-timeSprint end date.
statusstringCurrent sprint status.
goalstringSprint goal statement.
committed_pointsnumberStory points committed at sprint start.
completed_pointsnumberStory points completed by the end of the sprint.
task_idsjsonTask IDs committed to this sprint.
feature_idsjsonFeature IDs committed to this sprint.
lead_idstringUser ID of the sprint lead. Format: usr-<uuid>.
retrospectivejsonSprint retrospective notes. Populated after the sprint completes.
ai_planstringLLM-generated sprint plan.
tagsjsonFlat string tags for filtering and grouping.
versionnumberOptimistic-concurrency version counter.
starts_atdate-timeSprint start timestamp.
ends_atdate-timeSprint end timestamp.

API

client.projects.sprints.*
Loading manifest…