Skip to main content
API reference sections

Schema

AttributeDefinition

One attribute definition, flattened to tokens. The same shape for the compiled-in system registry and a workspace's custom records; system says which this is.

Type object

Shape

FieldTypeDescription
idrequiredstring

Stable identity: the namespaced key itself for a system attribute, a generated UUID for a custom one. Rename never changes it.

keyrequiredstring

The key values are stored under.

labelrequiredstring

Display only, freely renameable.

value_typerequiredstring

text, number, boolean, date, datetime_zoned, datetime_floating, select, multi_select.

The definition declares which temporal type the key takes. A shared key such as koru.due is datetime_zoned and refuses a floating value; a personal one such as koru.plan is datetime_floating and refuses a zoned one ([ADR-183]).

cardinalityrequiredstring

one | many.

scoperequiredstring

shared | personal. Personal values never appear in this response's rows - they live per profile, not on nodes.

systemrequiredboolean
optionsarray of string

The legal tokens for a select; empty otherwise, and empty for koru.tag, whose options are the tag table.

Default []

filterablerequiredboolean
sortablerequiredboolean
groupablerequiredboolean
Example
{
  "id": "string",
  "key": "string",
  "label": "string",
  "value_type": "string",
  "cardinality": "string",
  "scope": "string",
  "system": false,
  "options": [],
  "filterable": false,
  "sortable": false,
  "groupable": false
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.