Skip to content
Micro micro
Go to Micro
API Reference
Prism
Properties

Get metadata properties by object type

prism.properties.list(Literal["comment", "deal", "engagement", 9 more]object_type, PropertyListParams**kwargs) -> PropertyListResponse
GET/v2/prism/{teamId}/{objectType}/properties

Get metadata properties by object type

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
object_type: Literal["comment", "deal", "engagement", 9 more]
One of the following:
"comment"
"deal"
"engagement"
"identity"
"ai_chat_thread"
"ai_chat_message"
"agent_site"
"document"
"action"
"event"
"organization"
"contact"
autofill: Optional[bool]
include_options: Optional[Union[bool, Literal["true", "false", "0", "1"]]]

When false, return property definitions without hydrating select/multiselect option rows. Defaults to true server-side (parseIncludeOptions). Accepts boolean or query-string forms (true/false/0/1). Uses anyOf (not oneOf) so qs/AJV boolean-vs-string ambiguity does not 400 when Speakeasy SDKs send include_options=true.

One of the following:
bool
Literal["true", "false", "0", "1"]
One of the following:
"true"
"false"
"0"
"1"
list_id: Optional[str]

Scope properties to a specific list/app. Scoping is strict: the response carries only that list’s definitions, not the workspace-global ones that also apply to its records. Call once with list_id and once without to see everything a write could resolve against.

formatuuid
term: Optional[str]

Case-insensitive substring match on the property name. Use this to find an existing property before creating a new one.

ReturnsExpand Collapse
Dict[str, object]

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.

Get metadata properties by object type

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
properties = client.prism.properties.list(
    object_type="comment",
)
print(properties)
{
  "foo": {}
}
Returns Examples
{
  "foo": {}
}