Playground

Playground

PlanItem

/api/v1/planner/plan-items

An item within a daily plan, optionally linked to a source record.

listgetcreateupdatedelete

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.
plan_id*stringParent daily plan ID.
title*stringPlan item title.
descriptionstringDetailed description of the plan item.
statusenumplanned | in_progress | completed | deferred | cancelledPlan item status.
prioritynumberPriority level (1 = highest, 5 = lowest).
estimated_minutesnumberEstimated time to complete in minutes.
actual_minutesnumberActual time spent in minutes.
scheduled_atdate-timeISO 8601 scheduled start time.
completed_atdate-timeISO 8601 completion timestamp.
source_idstringID of the source record (task, meeting, etc.).
source_typestringType of source record (task, meeting, manual).
tagsjsonFree-form tags.
project_iduuidParent project ID. Format: prj-<uuid>.
parent_task_iduuidParent task ID for subtask hierarchies.
sprint_iduuidSprint ID if this item is committed to a sprint.
feature_iduuidFeature ID if this item is grouped under a feature.
task_numberstringHuman-readable task number scoped to the project key.
story_pointsintegerAgile story point estimate.
estimated_hoursnumberEstimated hours to complete.
actual_hoursnumberActual hours logged against this item.
assignee_iduuidUser ID of the assignee. Format: usr-<uuid>.
reviewer_idsjsonUser IDs of reviewers.
labelsjsonFree-form label strings for categorisation.
due_datedate-timeItem due date (YYYY-MM-DD).
blocked_by_task_idsjsonTask IDs that must be completed before this item can proceed.
duplicates_task_iduuidTask ID that this item duplicates.
repository_refjsonLinked pull request or branch reference.
comment_countintegerNumber of comments on this item.
attachment_refsjsonReferences to attached files.
custom_fieldsjsonArbitrary key-value extension fields.

API

Loading manifest…