Playground

Playground

Objective

/api/v1/okr/objectives

A high-level outcome with an owner.

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.
periodstringPlanning period this Objective belongs to (e.g. '2026-Q4').
titlestringShort, action-oriented title for the Objective.
descriptionstringLonger narrative describing the intent and context of the Objective.
categorystringStrategic category this Objective contributes to.
owner_idstringUser ID of the person accountable for this Objective. Format: usr-<uuid>.
group_idstringGroup (department/team) that owns this Objective. Format: grp-<uuid>.
parent_objective_idstringID of the parent Objective for cascaded alignment.
key_result_idsjsonIDs of KeyResult records that contribute to this Objective. Format: krs-<uuid>.
statusstringCurrent lifecycle status of the Objective.
progress_pctnumberAggregate progress percentage (0–100), computed from linked KeyResults.
weightnumberRelative importance of this Objective within its parent (e.g. 0.3 = 30%).
linked_project_idsjsonIDs of execution projects that contribute to this Objective.
dependenciesjsonExternal dependencies that affect delivery of this Objective.
check_in_frequencystringHow often progress check-ins are expected for this Objective.
last_check_in_atdate-timeISO 8601 timestamp of the most recent check-in.
tagsjsonFree-form string tags for filtering and grouping.
versionnumberOptimistic-lock version counter, incremented on each write.

API

client.okr.objectives.*
Loading manifest…