Skip to content
Micro micro
Go to Micro
API Reference
Prism

Properties

Get metadata properties by object type
client.prism.properties.list("comment" | "deal" | "engagement" | 9 moreobjectType, PropertyListParams { teamId, autofill, include_options, 2 more } params?, RequestOptionsoptions?): PropertyListResponse
GET/v2/prism/{teamId}/{objectType}/properties
Get metadata properties
client.prism.properties.listAll(PropertyListAllParams { teamId, autofill, include_options, 2 more } params?, RequestOptionsoptions?): PropertyListAllResponse
GET/v2/prism/{teamId}/properties
Create a property definition
client.prism.properties.create("comment" | "deal" | "engagement" | 9 moreobjectType, PropertyCreateParams { teamId, name, type, 7 more } params, RequestOptionsoptions?): PropertyDefinition { id, slug, type, 10 more }
POST/v2/prism/{teamId}/{objectType}/properties
Update a property definition
client.prism.properties.update(stringpropertyID, PropertyUpdateParams { teamId, objectType, type, 6 more } params, RequestOptionsoptions?): PropertyDefinition { id, slug, type, 10 more }
PATCH/v2/prism/{teamId}/{objectType}/properties/{propertyId}
Delete a property definition
client.prism.properties.delete(stringpropertyID, PropertyDeleteParams { teamId, objectType, type, list_id } params, RequestOptionsoptions?): void
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}
ModelsExpand Collapse
PropertyDefinition { 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).

id: string
formatuuid
slug: string
type: "num" | "str" | "bool" | 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
alias?: "app_stage" | null

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.

crm_id?: string | null

Identifier of the list this definition is scoped to, when applicable.

formatuuid
list_id?: string | null

Canonical identifier of the list this definition is scoped to.

formatuuid
locked?: boolean
name?: string | null
native?: boolean
options?: Array<PropertyOption { id, slug, color_scheme, 7 more } >

Present only for select_str and multiselect_str types.

id: string
formatuuid
slug: string
color_scheme?: string | null
Deprecatedcrm_id?: string | null
formatuuid
description?: string | null
icon?: string | null
list_id?: string | null
formatuuid
option_group?: string | null
sort_index?: number | null
value?: string | null

Display value for the option.

required?: boolean

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.

role_id?: string | null

The property’s display format. Always populated on definitions created through this API; a null here means the definition predates that and will render as an unknown format until it is patched.

formatuuid
team_id?: string | null
formatuuid
PropertyDefinitionCreate { 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.

name: string

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" | "str" | "bool" | 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
icon?: string | null
list_id?: string | null

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.

formatuuid
options?: Array<Option>

Only honored when type is select_str or multiselect_str.

value: string
color_scheme?: string | null
description?: string | null
icon?: string | null
option_group?: string | null
slug?: string
sort_index?: number | null
required?: boolean

When true, records must carry a non-empty value for this property on create. Defaults to false.

role_id?: string | null

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.

formatuuid
slug?: string

URL-safe identifier. When omitted it defaults to a slugified name and is disambiguated with a numeric suffix on conflict. When supplied explicitly it is treated as part of your write contract and is never silently renamed — a collision returns 409 instead.

PropertyDefinitionPatch { 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.

type: "num" | "str" | "bool" | 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
enabled?: boolean
icon?: string | null
list_id?: string | null
formatuuid
name?: string
required?: boolean
PropertyListResponse = Record<string, unknown>

Property definitions keyed by object type, then by property definition id (UUID). When the request scopes to a single object type, only that key is present.

PropertyListAllResponse = Record<string, unknown>

Property definitions keyed by object type, then by property definition id (UUID). When the request scopes to a single object type, only that key is present.

PropertiesOptions

Add an option to a select property
client.prism.properties.options.create(stringpropertyID, OptionCreateParams { teamId, objectType, type, 9 more } params, RequestOptionsoptions?): PropertyOption { id, slug, color_scheme, 7 more }
POST/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options
Update a property option
client.prism.properties.options.update(stringoptionID, OptionUpdateParams { teamId, objectType, propertyId, 11 more } params, RequestOptionsoptions?): PropertyOption { id, slug, color_scheme, 7 more }
PATCH/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}
Delete a property option
client.prism.properties.options.delete(stringoptionID, OptionDeleteParams { teamId, objectType, propertyId, 2 more } params, RequestOptionsoptions?): void
DELETE/v2/prism/{teamId}/{objectType}/properties/{propertyId}/options/{optionId}
ModelsExpand Collapse
PropertyOption { id, slug, color_scheme, 7 more }

An enabled option for a select_str or multiselect_str property definition.

id: string
formatuuid
slug: string
color_scheme?: string | null
Deprecatedcrm_id?: string | null
formatuuid
description?: string | null
icon?: string | null
list_id?: string | null
formatuuid
option_group?: string | null
sort_index?: number | null
value?: string | null

Display value for the option.

PropertyOptionCreate { 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.

type: "num" | "str" | "bool" | 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
value: string

Display value for the option.

color_scheme?: string | null
description?: string | null
icon?: string | null
list_id?: string | null

Scope the option to a specific list/app.

formatuuid
option_group?: string | null
slug?: string

URL-safe identifier. Defaults to a slugified value.

sort_index?: number | null
PropertyOptionPatch { type, color_scheme, description, 7 more }

Partial update of a property option. type identifies the per-type option table to write.

type: "num" | "str" | "bool" | 34 more

Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.

One of the following:
"num"
"str"
"bool"
"date"
"text"
"byte"
"select_str"
"multi_str"
"multiselect_str"
"jsonb"
"ref_identity"
"ref_user"
"ref_organization"
"ref_contact"
"ref_thread"
"ref_message"
"ref_event"
"ref_account"
"ref_ai_chat_thread"
"ref_ai_chat_message"
"multiref_ai_chat_message"
"multiref_agent_site"
"multiref_action"
"multiref_comment"
"multiref_contact"
"multiref_label"
"multiref_thread"
"multiref_messages"
"multiref_document"
"multiref_identity"
"multiref_organization"
"multiref_engagement"
"multiref_attendee"
"multiref_meeting_entry"
"multiref_read_receipt"
"multiref_account"
"multiref_source"
color_scheme?: string | null
description?: string | null
enabled?: boolean
icon?: string | null
list_id?: string | null
formatuuid
option_group?: string | null
slug?: string
sort_index?: number | null
value?: string