x-cpod-domain: planner

Planner

Daily plans and plan items for personal and team productivity.

Try in explorer client.planner

DailyPlan

A daily plan owned by a user, grouping plan items for a date.

REST path/api/v1/planner/daily-plans

Operations

listgetcreateupdatedelete

SDK

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

// create:
await client.planner.dailyPlans.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  date: "example date",
  owner_id: "example owner_id",
})

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.
date*	string	Plan date (YYYY-MM-DD).
owner_id*	string	User ID of the plan owner.
focus	string	Primary focus or theme for the day.
status	enum	Plan lifecycle status.`draftactivecompletedarchived`
notes	string	Free-form notes for the day.
tags	json	Free-form tags.

PlanItem

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

REST path/api/v1/planner/plan-items

Operations

listgetcreateupdatedelete

SDK

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

// create:
await client.planner.planItems.create({
  id: "rec_01HXEXAMPLE",
  tenant_id: "example tenant_id",
  created_at: "2026-01-01T00:00:00Z",
  updated_at: "2026-01-01T00:00:00Z",
  plan_id: "example plan_id",
  title: "example title",
})

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.
plan_id*	string	Parent daily plan ID.
title*	string	Plan item title.
description	string	Detailed description of the plan item.
status	enum	Plan item status.`plannedin_progresscompleteddeferredcancelled`
priority	number	Priority level (1 = highest, 5 = lowest).
estimated_minutes	number	Estimated time to complete in minutes.
actual_minutes	number	Actual time spent in minutes.
scheduled_at	date-time	ISO 8601 scheduled start time.
completed_at	date-time	ISO 8601 completion timestamp.
source_id	string	ID of the source record (task, meeting, etc.).
source_type	string	Type of source record (task, meeting, manual).
tags	json	Free-form tags.
project_id	uuid	Parent project ID. Format: prj-<uuid>.
parent_task_id	uuid	Parent task ID for subtask hierarchies.
sprint_id	uuid	Sprint ID if this item is committed to a sprint.
feature_id	uuid	Feature ID if this item is grouped under a feature.
task_number	string	Human-readable task number scoped to the project key.
story_points	integer	Agile story point estimate.
estimated_hours	number	Estimated hours to complete.
actual_hours	number	Actual hours logged against this item.
assignee_id	uuid	User ID of the assignee. Format: usr-<uuid>.
reviewer_ids	json	User IDs of reviewers.
labels	json	Free-form label strings for categorisation.
due_date	date-time	Item due date (YYYY-MM-DD).
blocked_by_task_ids	json	Task IDs that must be completed before this item can proceed.
duplicates_task_id	uuid	Task ID that this item duplicates.
repository_ref	json	Linked pull request or branch reference.
comment_count	integer	Number of comments on this item.
attachment_refs	json	References to attached files.
custom_fields	json	Arbitrary key-value extension fields.

Docs

DailyPlan

PlanItem