x-cpod-domain: performance

Performance

Goals and learning records on the performance review surface.

Try in explorer client.performance

PersonGoal

A goal assigned to a Person, often quarterly.

REST path/api/v1/performance/goals

Operations

listgetcreateupdate

SDK

// list — returns only your records; add filters/search:
await client.performance.goals.list()

// create:
await client.performance.goals.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App 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-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
person_id	uuid	UUID of the Person this goal belongs to.
title	string	Short descriptive title for this goal.
description	string	Detailed description of the goal, its success criteria, and context.
category	string	Classification of the goal's purpose.
period	string	The period this goal is scoped to (e.g. '2026-Q2', '2026-H1', '2026-Annual').
target_date	date-time	ISO 8601 date by which this goal should be achieved.
status	string	Current progress status of the goal.
progress_pct	number	Percentage of completion, 0–100.
linked_objective_id	uuid	UUID of a parent OKR Objective this goal contributes to, if applicable.
review_cycle_id	string	Identifier of the performance review cycle this goal is associated with.

LearningRecord

A completion record of a learning artifact.

REST path/api/v1/performance/learning-records

Operations

listgetcreate

SDK

// list — returns only your records; add filters/search:
await client.performance.learningRecords.list()

// create:
await client.performance.learningRecords.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  app_id: "example app_id",
  created_by: "rec_01HXEXAMPLE",
})

Field	Type	Description
id*	uuid	Server-assigned ULID with type prefix (e.g. per_…).
tenant_id*	string	Tenant scope — auto-stamped from the caller's JWT.
app_id	string	App 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-time	Server stamp.
updated_at*	date-time	Server stamp; updated on every patch.
created_by	uuid	Person id from the caller's JWT (sub).
updated_by	uuid	Person id from the last writer's JWT (sub).
source	string	Provenance tag — defaults to 'edm'.
source_type	enum	Where the write originated. Defaults to 'api'.`frontendbackendserversystemapi`
is_deleted	boolean	Soft-delete flag. Excluded from default list queries.
deleted_at	date-time	Stamped when soft-deleted; null otherwise.
deleted_by	uuid	Person id who soft-deleted; null otherwise.
schema_version	number	Document schema version. Bumped on incompatible writes.
person_id	uuid	UUID of the Person this learning record belongs to.
title	string	Name of the course, certification, or learning activity.
provider	string	Name of the training provider or certification body (e.g. 'AWS', 'Coursera', 'LinkedIn Learning').
completed_at	date-time	ISO 8601 timestamp when the learner completed or passed the course/exam. Null if not yet completed.
expires_at	date-time	ISO 8601 date when the certification or training record expires. Null if it does not expire.
score	number	Numeric score achieved (0–100). Null if scoring is not applicable.
passed	boolean	Whether the learner passed the assessment. Null if pass/fail is not applicable.
certification_ref	string	External credential URL, badge ID, or certification reference number.
linked_cohort_id	uuid	UUID of the training cohort this record is associated with, if applicable.
linked_assessment_id	uuid	UUID of the formal assessment that generated this learning record, if applicable.

Docs

PersonGoal

LearningRecord