API schemas · org docs

`Accepted`

The result of accepting an invitation.

Field	Type	Description
`actor_id` required	string (uuid)	Your new actor.
`handle` required	string	Your handle there.
`org` required	string	The org slug.

`ActionBody`

A task action's body (fields apply per action).

Field	Type	Description
`base_revision`	integer (int64) \| null	The page revision the action was based on.
`claim_id`	string (uuid) \| null	The claim (claims are idempotent per `claim_id`; one is minted if absent).
`completion_source`	CompletionSource	Completion attribution (`complete`, or `set_state` to done); defaults to `performed`.
`evidence`	string \| null	Evidence (`submit`, `approve`, `reject`).
`keyword`	string \| null	The keyword (`set_state`).
`lease_minutes`	integer (int32) \| null	Lease length (1–240 minutes).
`note`	string \| null	A note (`release`, `complete`, `set_state`, `note`), or the reason (`cancel`, `reopen`).
`override_claim`	boolean	A human overriding someone else's claim.
`reason`	string \| null	The reason (`cancel`, `reopen`).

`ActionResponse`

An action's result: the task, and what happened.

TaskView & object

`ActorStatus`

An actor's status.

"active" | "paused" | "revoked"

`Agenda`

An agenda.

Field	Type	Description
`end` required	string (date)	The last day.
`items` required	AgendaLine[]	The lines, by day then time.
`span` required	string	The span.
`start` required	string (date)	The first day.
`today` required	string (date)	Today, in your zone.

`AgendaBlock`

One block of a command.

Field	Type	Description
`match`	string \| null	Org match syntax.
`q`	string \| null	A query (§9.1).
`span`	string \| null	`agenda` blocks: the span.
`title`	string \| null	Its heading.
`type` required	string	`agenda`, `todo`, `match`, `stuck` or `search`.

`AgendaCommand`

An agenda command.

Field	Type	Description
`blocks` required	AgendaBlock[]	The blocks.
`key` required	string	Its dispatcher key.
`page` required	object	The page defining it.
`settings` required	object	`skip_done`, `tag_filter`, …
`title` required	string	Title.

`AgendaEntry`

An agenda line's entry.

Field	Type	Description
`ancestors` required	AncestorRef[]	Enclosing headings on this page, outermost first, excluding this entry.
`category`	string \| null	`category::`
`keyword`	string \| null	Keyword.
`owner`	string \| null	Owner handle.
`page` required	object	The page.
`priority`	string \| null	Priority.
`short_id` required	string	Short ID.
`state_class`	string \| null	State class.
`tags` required	string[]	Tags (with inherited).
`title` required	string	Title.

`AgendaLine`

One agenda line.

Field	Type	Description
`date` required	string (date)	The day it's shown on.
`days`	integer (int64) \| null	Days relative to the timestamp.
`end_time`	string \| null	`HH:MM`.
`entry` required	AgendaEntry	The entry.
`kind` required	string	`scheduled`, `deadline`, `appointment`, `deadline_warning`, `overdue`, `preview`, `habit` or `anniversary`.
`org`	string \| null	The hat (cross-hat agenda only).
`time`	string \| null	`HH:MM`, when timed.
`timestamp` required	string	The timestamp it comes from.

`Agent`

An agent.

Field	Type	Description
`allow_direct_task_completion` required	boolean	The human owner permits direct completion when the task's effective review is `auto`.
`client_id`	string \| null	The OAuth client that created it.
`client_name`	string \| null	The OAuth client's name, when a client created it.
`created_at` required	string (date-time)	Created.
`display_name` required	string	Display name.
`handle` required	string	Handle.
`icon`	string \| null	Icon.
`id` required	string (uuid)	Id.
`last_seen_at`	string (date-time) \| null	When it last used a token or did anything audited.
`owner`	null \| AgentOwner
`scopes` required	string[]	Scopes it holds through live grants and tokens.
`scorecard`	null \| Scorecard
`status` required	ActorStatus	Status.

`AgentOwner`

An agent's owner.

Field	Type	Description
`handle` required	string	Its handle.
`id` required	string (uuid)	The owner.
`kind` required	string	`human` or `team`.

`AncestorRef`

An enclosing heading on the entry's page, for nested task context.

Field	Type	Description
`short_id`	string \| null	Its short ID, when the heading has one.
`title` required	string	Its title without a TODO keyword, priority, tags or cookies.

`AncestorView`

An ancestor in a context packet.

Field	Type	Description
`properties` required	map of string	Its own properties.
`short_id`	string \| null	Its short ID.
`title` required	string	Its title.

`Anchor`

A daily anchor.

Field	Type	Description
`day` required	string (date)	The UTC day.
`hash` required	string	Its hash, hex.
`last_event_id` required	integer (int64)	The day's last event.

`Answer`

A POST /confirmations/{token} body.

Field	Type	Description
`answer` required	string	The answer (one of the options, or free text); `decline` refuses.

`Applied`

The result of applying.

Field	Type	Description
`pages` required	Committed[]	Pages changed, with their revisions.
`replaced` required	integer	Matches replaced.
`undo_receipt`	string (uuid) \| null	The undo receipt (`POST /orgs/{org}/undo` reverses it).

`ApplySpec`

Applying a replacement.

FindSpec & object

`AttachmentRef`

An attachment reference.

Field	Type	Description
`filename` required	string	The file name.
`short_id` required	string	Its short ID.
`url` required	string	The download link.

`AttachmentView`

An attachment as the API shows it.

Field	Type	Description
`content_type` required	string	The sniffed content type.
`created_at` required	string (date-time)	When.
`created_by`	string \| null	Who uploaded it.
`deleted_at`	string (date-time) \| null	When it was trashed.
`download_url` required	string	The download endpoint (absolute; redirects to a signed URL).
`entry`	string \| null	The entry's short ID.
`filename` required	string	The file name.
`id` required	string (uuid)	Its id.
`metadata` required	any	Previews, page counts, media metadata and diagnostics.
`page`	string \| null	The page's short ID.
`preview_url`	string \| null	The preview endpoint (absolute), once a thumbnail exists.
`quarantined` required	boolean	Whether scanning found malware (downloads are refused).
`sha256` required	string	SHA-256, hex.
`short_id` required	string	Its short ID.
`size` required	integer (int64)	Bytes.
`url` required	string	The deep link.
`version` required	integer (int32)	The current version (from 1).

`Attempt`

A prior attempt, from the logbook.

Field	Type	Description
`at`	string \| null	The logbook timestamp.
`by` required	string	The actor handle.
`kind` required	AttemptKind	What happened.
`note`	string \| null	The handoff note or feedback.

`AttemptKind`

What a past attempt was.

"released" | "rejected" | "reopened"

`AuditEntry`

One audit event as a reader sees it.

Field	Type	Description
`action` required	string	The action.
`actor_id`	string (uuid) \| null	Who acted.
`at` required	string (date-time)	When.
`client`	string \| null	Client.
`conversation_ref`	string \| null	The agent's conversation reference.
`diff`	object \| null	The diff (redacted where needed).
`hash` required	string	The event hash, hex.
`id` required	integer (int64)	The event id.
`ip`	string \| null	Client IP (admins only).
`on_behalf_of`	string (uuid) \| null	The human an agent acted for.
`reason`	string \| null	The reason.
`redacted` required	boolean	Whether titles were redacted.
`request_id`	string \| null	The request ID.
`resource_id`	string (uuid) \| null	The resource.
`resource_type` required	string	The resource type.
`short_id`	string \| null	Its short ID.
`space_id`	string (uuid) \| null	Its space.
`summary` required	string	A plain-language summary.
`task_id`	string (uuid) \| null	The task.
`user_agent`	string \| null	User agent (admins only).
`via` required	string	Surface.

`Backlink`

A link to a page.

Field	Type	Description
`context` required	string	Text around the link.
`entry`	object \| null	The linking entry.
`page` required	object	The linking page.

`BatchBody`

A POST /tasks:batch body.

Field	Type	Description
`dry_run`	boolean	Report what would happen, writing nothing.
`import_id`	string (uuid) \| null	Record the items in this import (so it can be undone as a unit).
`items` required	TaskInput[]	The tasks. Items with `source` and `external_id` upsert.
`source`	string \| null	The default `source` for items.

`BatchItem`

One batch item's result.

Field	Type	Description
`action` required	string	`created`, `updated` or `skipped`.
`duplicate_of`	null \| DuplicateHint
`index` required	integer	The item's index.
`short_id`	string \| null	The entry.
`url`	string \| null	Its link.

`BatchResult`

The batch result.

Field	Type	Description
`dry_run` required	boolean	Nothing was written.
`import_id`	string (uuid) \| null	The import, if any.
`items` required	BatchItem[]	Per item.
`summary` required	object	Counts.

`Billing`

Billing status.

Field	Type	Description
`active_seats` required	integer (int64)	Active human members (guests are free).
`current_period_end`	string (date-time) \| null	Current period end.
`enabled` required	boolean	Whether billing applies.
`provider` required	string	`none` or `stripe`.
`read_only` required	boolean	Read-only for non-payment.
`seats`	integer (int32) \| null	Paid seats.
`status`	string \| null	The subscription status (`trialing`, `active`, …), if any.
`trial_ends_at`	string (date-time) \| null	Trial end.

`Blocker`

One blocker, as the API returns it (§7.4).

Field	Type	Description
`reason` required	BlockerReason	Why it blocks.
`short_id`	string \| null	The blocking entry's short ID.

`BlockerReason`

Why a task is blocked.

"depends_open" | "depends_cancelled" | "depends_missing" | "child_open" | "earlier_sibling_open"

`BlockResult`

One block's results.

AgendaBlock & object

`Budget`

Money, as budget:: gives it (§5.4): £450, $20, 100 EUR.

Field	Type	Description
`amount` required	number (double)	The amount. Whole amounts serialise as integers.
`currency` required	string	The ISO 4217 code.

`CalendarItem`

A calendar entry.

Field	Type	Description
`date` required	string (date)	Its day.
`row` required	string	The row.
`time`	string \| null	Its time, if any.

`Capabilities`

What this server offers.

Field	Type	Description
`features` required	object	Features that depend on configuration.
`limits` required	object	Limits.
`versions` required	object	Versions.

`CaptureBody`

A capture.

Field	Type	Description
`body`	string \| null	`{{body}}`.
`clipboard`	string \| null	`{{clipboard}}`.
`prompts`	map of string	`{{prompt:Label}}` answers.
`selection`	string \| null	`{{selection}}`.
`template`	string \| null	A capture template's key (from a ```capture block).
`text`	string \| null	Quick-add text (`Call Sam tomorrow 3pm #work !A`), used when there's no template.
`title`	string \| null	`{{title}}`.
`url`	string \| null	`{{url}}`.

`Captured`

What a capture made.

Field	Type	Description
`page` required	object	The page it went to.
`short_id`	string \| null	The entry, when it made one.
`suggestions`	object \| null	Jev suggestions for the new entry, when ready (triage runs as a job: read them later on the entry).
`url` required	string	The deep link.

`ChainBreak`

The first break found, if any.

Field	Type	Description
`at` required	string (date-time)	When it claims to have happened.
`id` required	integer (int64)	The event where the chain breaks.
`reason` required	string	`hash_mismatch`, `prev_hash_mismatch` or `head_mismatch`.

`ChangeActor`

The acting actor of an event.

Field	Type	Description
`handle` required	string	Its handle.
`id` required	string (uuid)	The actor.
`kind` required	string	Its kind.

`ChangeEvent`

One event in the feed.

Field	Type	Description
`actor`	null \| ChangeActor
`created_at` required	string (date-time)	When.
`data` required	object	A small summary.
`entity_id`	string (uuid) \| null	The entity.
`entity_type` required	string	The entity's type.
`id` required	integer (int64)	The event id.
`short_id`	string \| null	Its short ID.
`space_id`	string (uuid) \| null	Its space.
`type` required	string	The type.
`url`	string \| null	Its deep link.
`via`	string \| null	Surface.

`ChangesPage`

A page of the feed.

Field	Type	Description
`events` required	ChangeEvent[]	Events in order.
`next_cursor` required	string	Pass as `since` next time. Always set: an empty page returns the same position.

`Checklist`

Done and total counts for a checklist or child tasks (§7.11).

Field	Type	Description
`done` required	integer (int32)	Done items.
`total` required	integer (int32)	All items.

`Checkout`

A checkout link.

Field	Type	Description
`url` required	string	Where to send the owner.

`ClaimView`

A claim in a payload.

Field	Type	Description
`by`	string \| null	The claimant's handle.
`claim_id` required	string (uuid)	The claim's key.
`claimed_at`	string (date-time) \| null	When it was taken.
`expired` required	boolean	The lease has ended (the task is claimable again).
`lease_until`	string (date-time) \| null	When the lease ends.
`stale` required	boolean	The task changed since it was claimed.

`ClockRow`

A clock table row.

Field	Type	Description
`key` required	string	The group key: an entry or page short ID, or a handle.
`minutes` required	integer (int64)	Minutes in the range (running clocks count up to now).
`title`	string \| null	Its title (entries and pages).

`Clocktable`

A clock table.

Field	Type	Description
`end` required	string (date)	Last day.
`rows` required	ClockRow[]	Rows, most time first.
`start` required	string (date)	First day.
`total` required	integer (int64)	Total minutes.

`Column`

A board column.

Field	Type	Description
`items` required	string[]	The short IDs in it, in rank order.
`key` required	string	The keyword (or group value).
`terminal` required	boolean	Terminal keywords come last.

`CommandResults`

A command's results, block by block.

Field	Type	Description
`blocks` required	BlockResult[]	Its blocks' results, in order.
`command` required	AgendaCommand	The command.

`CommentView`

A comment as the API shows it. Top-level comments carry their thread in replies.

Field	Type	Description
`anchor`	string \| null	The Yjs relative positions, base64.
`author`	string \| null	The author's handle.
`author_kind`	string \| null	`human` or `agent`.
`body` required	string	The text (empty once deleted).
`created_at` required	string (date-time)	When.
`deleted` required	boolean	Deleted (kept as a placeholder while it has replies).
`edited_at`	string (date-time) \| null	When the author last edited it.
`entry`	string \| null	The entry's short ID, when it's on one.
`id` required	string (uuid)	Its id.
`mentions` required	string[]	The handles it mentions.
`page` required	string	The page's short ID.
`parent`	string \| null	The thread's first comment (for replies).
`quote`	string \| null	The quoted text it's anchored to.
`replies` required	CommentView[]	Replies, oldest first.
`resolved_at`	string (date-time) \| null	When its thread was resolved.
`resolved_by`	string \| null	Who resolved it.
`short_id` required	string	Its short ID.
`url` required	string	The deep link.

`Committed`

A committed page change.

Field	Type	Description
`after_rev` required	integer (int64)	The revision after it.
`before_rev` required	integer (int64)	The revision before the change.
`page_id` required	string (uuid)	The page.

`CompletionSource`

Whether a completion records the actor's work or its human owner's report.

"performed" | "human_report"

`Confirmation`

A confirmation request.

Field	Type	Description
`decision`	null \| Decision
`expires_at`	string (date-time) \| null	When the link expires.
`risk`	number (float) \| null	Jev's risk score (0–1). At or above the org's `risk_threshold`, standing rules don't apply: the human confirms.
`token`	string \| null	The token (for `POST /confirmations/{token}`).
`url`	string \| null	The page the human opens, unless a standing rule already decided.

`ContextPacket`

The context packet (§15.4).

Field	Type	Description
`ancestors` required	AncestorView[]	Ancestors, outermost first.
`attachments` required	AttachmentRef[]	Attachments.
`backlinks` required	LinkedPage[]	Pages and entries linking to the task.
`decisions` required	Decision[]	Decisions on the task.
`last_occurrences` required	Occurrence[]	The last three completions of a repeating task, newest first.
`linked_pages` required	LinkedPage[]	Pages the task links to.
`prior_attempts` required	Attempt[]	Releases, rejections and resets, newest first.
`secrets` required	string[]	Names of secrets the task references (never values).
`task` required	TaskView	The task.

`ConvertBody`

A POST /convert body.

Field	Type	Description
`from` required	string	`org` (Org mode) or `aegent-md`.
`source` required	string	The text to convert.
`to` required	string	`aegent-md` or `org`.

`Converted`

A conversion's result.

Field	Type	Description
`details` required	ConvertNote[]	The same, structured.
`diagnostics` required	string[]	Diagnostics as lines (`line 3: …`).
`markdown` required	string	The converted text (`markdown` for aegent Markdown, else the Org text).

`ConvertNote`

A conversion diagnostic.

Field	Type	Description
`code` required	string	`unmapped`, `encrypted`, `unresolved_id`, `tag_renamed`, `property_key`, …
`line` required	integer	The 1-based line in the input.
`message` required	string	What happened.

`CoordRev`

One task's coordination state around an action.

Field	Type	Description
`after` required	object	After it.
`before` required	object	Before the action.
`entry_id` required	string (uuid)	The entry.

`CreateAddress`

A new address.

Field	Type	Description
`space`	string \| null	The space captures go to (default: your inbox).
`template`	string \| null	A capture template key.

`CreateAgent`

A POST /agents body.

Field	Type	Description
`allow_direct_task_completion`	boolean	Permit direct completion under `auto` review (default: false).
`display_name` required	string	Display name.
`handle`	string \| null	Handle (default: from the name).
`icon`	string \| null	Icon.
`owner`	string \| null	Owner: a human or team handle (default: you).

`CreateComment`

A POST …/comments body.

Field	Type	Description
`anchor`	string \| null	The Yjs relative-position pair, base64.
`body` required	string	The text; `@handle` mentions notify people, agents and teams.
`entry`	string \| null	The entry it's on (short ID or UUID).
`parent`	string \| null	The comment it replies to (replies join the thread's root).
`quote`	string \| null	The text it's about.

`CreateConfirmation`

A POST /tasks/{ref}/confirmations body.

Field	Type	Description
`category`	string \| null	The category, matched against standing rules.
`options`	string[] \| null	Choices; free text when absent.
`question` required	string	The question for the human.

`CreateFeed`

A new feed.

Field	Type	Description
`name` required	string	Name.
`query`	string	Only entries matching this (default: everything you can read).

`CreateInvite`

A POST /invites body.

Field	Type	Description
`email` required	string	Who.
`org_role` required	string	`admin`, `member` or `guest`.
`space_role`	null \| Role
`spaces`	string[]	Spaces (slugs or ids) to grant.

`CreateOrg`

A POST /orgs body.

Field	Type	Description
`handle`	string \| null	Your handle in the new org (default: your personal handle).
`name` required	string	The name.
`slug` required	string	The slug (2–32 of `a-z 0-9 _ -`, not reserved).

`CreatePage`

A POST /pages body. Give space, parent, or both (the parent must be in that space); with neither it's 422.

Field	Type	Description
`external_id`	string \| null	The page's id in `source`.
`icon`	string \| null	Icon.
`import_id`	string (uuid) \| null	The import batch, undone as a unit.
`markdown`	string \| null	The text (default: a heading with the title).
`parent`	string \| null	The parent page (short ID or id).
`source`	string \| null	Import provenance (§23.2), with `external_id`: a repeat updates the page if the text changed and otherwise skips it.
`space`	string \| null	The space (slug or id). Required unless `parent` is given; defaults to the parent's space.
`template`	string \| null	A template page to copy.
`title` required	string	Title.

`CreateRule`

A POST /decision-rules body.

Field	Type	Description
`agent` required	string	The agent's handle.
`category` required	string	The category, e.g. `draft`.
`expires_at`	string (date-time) \| null	Expiry.
`page`	string \| null	Limit to a page subtree (short ID or UUID).
`space`	string \| null	Limit to a space (slug or id).

`CreateSecret`

A POST /secrets body.

Field	Type	Description
`kind` required	string	Kind.
`meta`	object \| null	Metadata (no secret fields).
`name` required	string	Name.
`require_confirmation`	boolean	Reveals need a verified decision.
`space` required	string	The space (slug or id).
`value` required	object	The value: a JSON object with the kind's fields.

`CreateShareLink`

A POST /pages/{ref}/share-links body.

Field	Type	Description
`expires_in_days`	integer (int64) \| null	Days until it expires (default 30).
`role`	string \| null	`viewer` or `commenter`.

`CreateSpace`

A POST /spaces body.

Field	Type	Description
`default_role`	null \| Role
`humans_only`	boolean	Deny agents always.
`icon`	string \| null	Icon.
`name` required	string	Name.
`slug` required	string	Slug.
`visibility`	null \| Visibility

`CreateTeam`

A POST /teams body.

Field	Type	Description
`handle` required	string	Handle.
`name` required	string	Name.
`parent`	string \| null	The parent team's handle.

`CreateWebhook`

A POST /webhooks body.

Field	Type	Description
`events` required	string[]	Event types (`task.`, `page.created`, ``).
`spaces`	string[]	Only these spaces (slugs or ids).
`url` required	string	Where to deliver (https in production).

`Database`

A database's schema.

Field	Type	Description
`errors` required	string[]	Problems with the schema.
`properties` required	Property[]	The properties, in schema order.
`revision` required	integer (int64)	The page's revision.
`rows` required	RowsKind	Where rows come from.
`short_id` required	string	The database page's short ID (`tasks` for the Tasks database).
`title` required	string	Its title.
`views` required	DbView[]	Its views.

`DbRow`

One row.

Field	Type	Description
`created_at`	string (date-time) \| null	When the row was created.
`errors`	map of string	Coercion, formula and rollup errors by property key.
`id` required	string	The row's page or entry short ID (the `{row}` in the API).
`revision` required	integer (int64)	The revision of the page holding the row's values (the row page, or the database page for heading rows): send it as `base_revision`.
`title` required	string	Its title.
`updated_at`	string (date-time) \| null	When it last changed.
`values` required	map of any	Typed values by property key (lowercase, spaces as `_`, §10.1).

`DbView`

A saved view on a database.

Field	Type	Description
`date`	string \| null	Calendar and timeline: the date property.
`group_by`	string \| null	Board: the property to group by.
`layout`	string	`table` (default), `list`, `board`, `calendar`, `gallery`, `timeline`.
`name` required	string	Its name.
`q`	string	A filter (§9.1).
`sort`	string	`title`, `created`, `updated` or a property name, `-` for descending.

`Decision`

A decision.

Field	Type	Description
`answer` required	string	The answer.
`category`	string \| null	The category (e.g. `spend`, `reveal_secret`).
`client`	string \| null	The client.
`conversation_ref`	string \| null	The conversation reference.
`created_at` required	string (date-time)	When.
`decided_by`	string (uuid) \| null	Who decided.
`entry_id`	string (uuid) \| null	The task.
`id` required	string (uuid)	Id.
`options`	object \| null	The options offered.
`question` required	string	The question.
`recorded_by`	string (uuid) \| null	Who recorded it.
`rule_id`	string (uuid) \| null	The standing rule it came from.
`short_id` required	string	Short ID.
`verification` required	string	`agent_reported` or `verified`.

`DecisionRule`

A standing decision rule.

Field	Type	Description
`agent` required	string	Its handle.
`agent_id` required	string (uuid)	The agent.
`category` required	string	The category it pre-authorises.
`created_at` required	string (date-time)	Created.
`created_by`	string (uuid) \| null	Who created it.
`expires_at`	string (date-time) \| null	Expiry.
`id` required	string (uuid)	Id.
`page_id`	string (uuid) \| null	The page subtree scope.
`space_id`	string (uuid) \| null	The space scope.

`Deleted`

What deleting a row did.

Field	Type	Description
`row` required	string	The deleted row.
`unlinked` required	string[]	Rows in other databases whose relations pointed at it, now updated.

`Delivery`

One delivery attempt record.

Field	Type	Description
`attempt` required	integer (int32)	Attempts so far.
`created_at` required	string (date-time)	Created.
`delivered_at`	string (date-time) \| null	When it succeeded.
`error`	string \| null	The last error.
`event_id` required	integer (int64)	The event.
`event_type` required	string	The event type.
`id` required	string (uuid)	Id.
`next_attempt_at`	string (date-time) \| null	When the next attempt is due.
`response_ms`	integer (int32) \| null	The last response time.
`status_code`	integer (int32) \| null	The last response status.

`Detail`

summary or full detail.

"summary" | "full"

`DuplicateHint`

A possible duplicate of a new task (§21 use 4): a hint, never applied.

Field	Type	Description
`score` required	number (float)	How sure: 1 for an identical title, else the classifier's probability.
`short_id` required	string	The existing task's short ID.
`title` required	string	Its title.

`DuplicatePage`

A POST /pages/{ref}/duplicate body.

Field	Type	Description
`title`	string \| null	The copy's title (default: `<title> (copy)`).

`EntryKind`

Whether an entry is a heading or an inline task (entries.kind).

"heading" | "inline"

`EntryView`

Any entry (a heading or a task), for GET /entries/{ref}.

Field	Type	Description
`all_tags` required	string[]	Tags with inheritance.
`body` required	string	The body.
`deadline`	null \| TimeField
`fingerprint` required	Fingerprint	The requirements fingerprint.
`inherited` required	map of string	Inherited properties.
`keyword`	string \| null	The keyword, for tasks.
`kind` required	EntryKind	`heading` or `inline`.
`level` required	integer (int32)	The outline level.
`page` required	PageRef	The page.
`parent`	string \| null	The parent's short ID.
`priority`	string \| null	The priority.
`properties` required	map of string	Own properties.
`revision` required	integer (int64)	The page revision.
`scheduled`	null \| TimeField
`short_id`	string \| null	The entry's short ID.
`state_class`	null \| StateClass
`suggestions`	object \| null	Jev suggestions (§21), by kind: never applied, only offered.
`tags` required	string[]	Own tags.
`title` required	string	The title.
`url` required	string	The deep link.

`ExportFormat`

Export formats.

"jsonl" | "csv"

`ExportRequest`

POST /orgs/{org}/exports.

Field	Type	Description
`children`	boolean	Documents: include the page's descendants.
`format` required	string	`zip-md` (the full export) or a document format: `html`, `pdf`, `docx`, `odt`, `epub`, `revealjs`, `latex`, `txt`, `md`.
`include_secrets`	boolean	Zip: include secrets, encrypted with `passphrase` (humans only).
`passphrase`	string \| null	The passphrase for `secrets.json.age` (at least 12 characters).
`scope`	string \| null	What to export: `org` (default for zip), a space slug, or a page reference (required for documents).

`ExportView`

An export.

Field	Type	Description
`content_type`	string \| null	Its type.
`created_at` required	string (date-time)	When it was asked for.
`download_url`	string \| null	A 5-minute link, once done.
`error`	string \| null	The failure, in words.
`error_code`	string \| null	Why it failed: `export_tool_missing`, `export_failed`, `export_timeout`, `not_found`.
`expires_at`	string (date-time) \| null	Until when it can be downloaded.
`filename`	string \| null	The file's name.
`finished_at`	string (date-time) \| null	When it finished.
`format` required	string	The format.
`id` required	string (uuid)	Its id.
`scope` required	any	What was exported.
`size`	integer (int64) \| null	Its size.
`status` required	string	`queued`, `running`, `done` or `failed`.

`FindSpec`

What to find.

Field	Type	Description
`case_sensitive`	boolean	Match case (default false).
`find` required	string	The text to find (literal).
`scope`	string \| null	Limit to a space slug or page reference.
`whole_word`	boolean	Only whole words (default false).

`Fingerprint`

blake3 requirements fingerprint, b3:<hex>

string

`GrantView`

A grant.

Field	Type	Description
`created_at` required	string (date-time)	Created.
`role` required	Role	The role.
`subject` required	string	The subject's handle.
`subject_id` required	string (uuid)	The subject.
`subject_kind` required	string	`actor` or `team`.

`Group`

A board column.

Field	Type	Description
`rows` required	string[]	Row ids in the column.
`value`	string \| null	The value (`null` for rows without one).

`Guidance`

Agent guidance (§7.9), from agent::, agent_allow::, agent_ask:: and budget::, own or inherited.

Field	Type	Description
`allow` required	string[]	`agent_allow::`
`ask` required	string[]	`agent_ask::`
`budget`	null \| Budget
`text`	string \| null	`agent::`

`Hat`

One hat (org) the account belongs to (§16.2a).

Field	Type	Description
`actor_id` required	string (uuid)	The account's actor in the org.
`colour`	string \| null	Colour.
`favourites` required	string[]	Favourite pages and views (short IDs).
`handle` required	string	Its handle.
`hidden` required	boolean	Hidden by the visibility schedule right now.
`kind` required	string	`personal` or `shared`.
`name` required	string	The org name.
`org` required	HatOrg	The org.
`position` required	integer (int32)	Switcher order.
`role`	string \| null	The account's org role.
`teams` required	string[]	The actor's teams (handles).
`visibility` required	Window[]	Hidden windows.
`visible_now` required	boolean	Whether the hat is visible right now.

`HatOrg`

A hat's org.

Field	Type	Description
`kind` required	string	`personal` or `shared`.
`name` required	string	Name.
`slug` required	string	Slug.

`HatTask`

A task in the cross-hat list.

TaskView & object

`HitPage`

The page a hit belongs to.

Field	Type	Description
`short_id` required	string	Its short ID.
`title` required	string	Its title.

`HitSpace`

A space a hit is in.

Field	Type	Description
`name` required	string	Its name.
`slug` required	string	Its slug.

`HitType`

A kind of search result.

"page" | "entry" | "comment" | "attachment" | "actor"

`IcsFeed`

A calendar feed.

Field	Type	Description
`created_at` required	string (date-time)	Created.
`id` required	string (uuid)	Id.
`name` required	string	Name.
`query` required	string	The query (§9.1).
`url`	string \| null	The subscribe URL (only in the create response: it carries the token).

`ImportJob`

An import batch.

Field	Type	Description
`created_at` required	string (date-time)	Created.
`dry_run` required	boolean	A dry run.
`id` required	string (uuid)	Id: pass as `import_id` to `tasks:batch`.
`source` required	string	The source (`todoist`, `things`, …).
`status` required	string	`running`, `done` or `undone`.
`summary` required	object	Counts: created, updated, skipped, duplicate.
`undone_at`	string (date-time) \| null	Undone.

`InboundAddress`

An email-in address.

Field	Type	Description
`address` required	string	The full address.
`created_at` required	string (date-time)	Created.
`local_part` required	string	The part before `@`.
`space`	string \| null	Where captures go (space slug).

`Invite`

An invitation.

Field	Type	Description
`email` required	string	Email.
`expires_at` required	string (date-time)	Expiry.
`id` required	string (uuid)	Id.
`org_role` required	string	Role.
`space_ids` required	string (uuid)[]	Spaces granted on acceptance.
`token`	string \| null	The token (only in the create response).
`url`	string \| null	The accept link (only in the create response).

`Jump`

Where to jump to within the page: a byte range of its Markdown.

Field	Type	Description
`byte_end` required	integer	One past the last byte.
`byte_start` required	integer	First byte.

`KekRotated`

The result of a KEK rotation.

Field	Type	Description
`kek_version` required	integer (int32)	The new KEK version.
`rewrapped` required	integer (int64)	DEKs re-wrapped (values were not re-encrypted).

`KillReport`

What the kill switch did.

Field	Type	Description
`claims_released` required	integer (int64)	Claims released.
`paused` required	string[]	Agents paused.

`KillSwitch`

A POST /kill-switch body.

Field	Type	Description
`reason`	string \| null	Why.
`scope`	string \| null	`org` (owners and admins: every agent) or `mine` (your agents). Default `org`.

`KindPref`

A notification preference.

Field	Type	Description
`channels` required	string[]	`in_app`, `push`, `email`.
`kind` required	string	The kind.

`LinkedPage`

A linked page or backlink in a context packet.

Field	Type	Description
`short_id` required	string	The page's (or entry's) short ID.
`text` required	string	The first 500 characters (`summary`), or everything (`full`).
`title` required	string	Its title.
`truncated` required	boolean	Whether `text` was cut.

`Marked`

How many were marked.

Field	Type	Description
`marked` required	integer (int64)	Notifications marked read.

`MarkRead`

A POST /notifications/read body.

Field	Type	Description
`all`	boolean	Or every notification.
`ids`	string (uuid)[]	These notifications.

`Match`

One match.

Field	Type	Description
`byte_end` required	integer	One past its last byte.
`byte_start` required	integer	First byte of the match.
`context` required	string	The line around the match.
`highlight` required	integer[]	The match within `context`, in code points.
`id` required	string	`{page short ID}:{byte_start}`: pass back in `selected`.
`page` required	string	The page's short ID.
`revision` required	integer (int64)	The page's revision the match was found at.
`title` required	string	The page's title.
`writable` required	boolean	Whether the viewer may change this page.

`Me`

Who /me is.

Field	Type	Description
`account_id` required	string (uuid)	The account.
`acting_as`	string (uuid) \| null	For agent tokens, the agent the token acts as.
`display_name`	string \| null	Display name.
`email` required	string	Email.
`handle`	string \| null	The personal handle.
`locale` required	string	Locale.
`preferences` required	Preferences	Preferences.
`scopes` required	string[]	The token's scopes (empty for sessions, which hold every scope).
`tz` required	string	IANA time zone.

`Member`

A member (a human actor).

Field	Type	Description
`actor_id` required	string (uuid)	The actor.
`created_at` required	string (date-time)	Joined.
`display_name` required	string	Display name.
`email`	string \| null	Email (visible to admins).
`handle` required	string	Handle.
`org_role`	string \| null	Org role.
`status` required	string	`active`, `paused` or `revoked`.

`MovePage`

A POST /pages/{ref}/move body.

Field	Type	Description
`after`	string \| null	Put it right after this sibling (short ID).
`before`	string \| null	Put it right before this sibling (short ID).
`parent`	string \| null	The new parent (short ID), or `""` for top level.
`space`	string \| null	The new space (slug or id).

`NewPushSubscription`

A browser push subscription (the PushSubscription JSON).

Field	Type	Description
`endpoint` required	string	The push service endpoint.
`keys` required	PushKeys	The subscription keys.

`NotificationPrefs`

Notification preferences.

Field	Type	Description
`kinds` required	KindPref[]	Per-kind channels; kinds not listed use in-app and push.

`NotificationView`

A notification.

Field	Type	Description
`created_at` required	string (date-time)	Created.
`entity_id`	string (uuid) \| null	What it's about.
`entity_type`	string \| null	What it's about.
`id` required	string (uuid)	Id.
`kind` required	string	Kind.
`payload` required	object	Summary.
`read_at`	string (date-time) \| null	Read.

`Occurrence`

A past occurrence of a repeating task ("last time").

Field	Type	Description
`at`	string \| null	The logbook timestamp of the completion.
`keyword` required	string	The done keyword.
`note`	string \| null	The completion note.
`notes` required	string[]	Notes taken between this and the previous completion.

`Offboarding`

What happens to a removed member's things.

Field	Type	Description
`agents_to`	string \| null	Give their agents to this human or team (they stay paused).
`private_spaces`	string \| null	`transfer` (default) or `archive` their private spaces.
`private_spaces_to`	string \| null	Who receives transferred private spaces (default: you).
`reason`	string \| null	Why (recorded in the audit log).
`reassign_tasks_to`	string \| null	Reassign their owned tasks to this actor or team handle; unowned if absent.
`revoke_agents`	boolean	Revoke their agents instead of pausing them.

`OffboardReport`

What offboarding did.

Field	Type	Description
`agents` required	integer (int64)	Agents paused (or revoked).
`claims_released` required	integer (int64)	Live claims released.
`private_spaces` required	integer (int64)	Private spaces transferred or archived.
`secrets_flagged` required	integer (int64)	Secrets flagged `rotate_recommended`.
`tasks` required	integer (int64)	Tasks reassigned or unowned.

`Org`

An org.

Field	Type	Description
`actor_id` required	string (uuid)	The caller's actor.
`created_at` required	string (date-time)	Created.
`id` required	string (uuid)	Id.
`kind` required	string	`personal` or `shared`.
`name` required	string	Name.
`role`	string \| null	The caller's role (humans).
`slug` required	string	Slug.

`OrgRole`

An org role (humans only).

"owner" | "admin" | "member" | "guest"