Properties
Get metadata properties by object type
Get metadata properties
Create a property definition
Update a property definition
Delete a property definition
ModelsExpand Collapse
PropertyDefinition object { id, slug, type, 10 more } Definition for a single property on an object type. Definitions with team_id and crm_id null are shared defaults; values may be scoped to a team and/or list (crm).
Definition for a single property on an object type. Definitions with team_id and crm_id null are shared defaults; values may be scoped to a team and/or list (crm).
type: "num" or "str" or "bool" or 34 moreStorage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.
Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.
Reserved alias naming this definition, or null. app_stage marks the list pipeline stage definition. Resolve stages by this field rather than by name, slug, or team_id: a superseded native status definition can coexist with the pipeline one and is otherwise identical on the wire.
Identifier of the list this definition is scoped to, when applicable.
When true, records of this object type must carry a non-empty value for this property on create, and a patch may not clear it.
PropertyDefinitionCreate object { name, type, icon, 5 more } New property definition. Check for an existing property first (GET the same path with term) and reuse it rather than defining a near-duplicate — writes address properties by slug, so two definitions sharing a slug leave no addressable winner. For select_str/multiselect_str types you may pre-seed choices via options.
New property definition. Check for an existing property first (GET the same path with term) and reuse it rather than defining a near-duplicate — writes address properties by slug, so two definitions sharing a slug leave no addressable winner. For select_str/multiselect_str types you may pre-seed choices via options.
Human-readable name, unique within the scope the definition is created in. A name already taken in that scope returns 409; the message names the existing definition’s id, slug and type so you can write to it instead.
type: "num" or "str" or "bool" or 34 moreStorage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.
Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.
Scopes the definition to one list/app. Omit it only for a property that genuinely belongs to the whole workspace: a definition created without list_id is workspace-global and surfaces on every list of this object type.
options: optional array of object { value, color_scheme, description, 4 more } Only honored when type is select_str or multiselect_str.
Only honored when type is select_str or multiselect_str.
When true, records must carry a non-empty value for this property on create. Defaults to false.
Optional display format for the property, drawn from the workspace’s property roles. Omit it and the canonical role for type is applied (plain text, plain number, checkbox). Supply it only to pick a narrower format such as email, URL or currency; the role’s data type must match type.
PropertyDefinitionPatch object { type, enabled, icon, 3 more } Partial update of a property definition. Only name, icon, enabled, and required are editable. type identifies the per-type table to write.
Partial update of a property definition. Only name, icon, enabled, and required are editable. type identifies the per-type table to write.
PropertiesOptions
Add an option to a select property
Update a property option
Delete a property option
ModelsExpand Collapse
PropertyOptionCreate object { type, value, color_scheme, 6 more } New option for a select_str or multiselect_str property. type identifies the per-type option table to write.
New option for a select_str or multiselect_str property. type identifies the per-type option table to write.
PropertyOptionPatch object { type, color_scheme, description, 7 more } Partial update of a property option. type identifies the per-type option table to write.
Partial update of a property option. type identifies the per-type option table to write.