Playground

Playground

PersonGoal

/api/v1/performance/goals

A goal assigned to a Person, often quarterly.

listgetcreateupdate

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.
person_iduuidUUID of the Person this goal belongs to.
titlestringShort descriptive title for this goal.
descriptionstringDetailed description of the goal, its success criteria, and context.
categorystringClassification of the goal's purpose.
periodstringThe period this goal is scoped to (e.g. '2026-Q2', '2026-H1', '2026-Annual').
target_datedate-timeISO 8601 date by which this goal should be achieved.
statusstringCurrent progress status of the goal.
progress_pctnumberPercentage of completion, 0–100.
linked_objective_iduuidUUID of a parent OKR Objective this goal contributes to, if applicable.
review_cycle_idstringIdentifier of the performance review cycle this goal is associated with.

API

client.performance.goals.*
Loading manifest…