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

Get metadata properties by object type

prism.properties.list(Literal["deal", "identity", "ai_chat_thread", 6 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["deal", "identity", "ai_chat_thread", 6 more]
One of the following:
"deal"
"identity"
"ai_chat_thread"
"ai_chat_message"
"document"
"action"
"event"
"organization"
"contact"
autofill: Optional[bool]
list_id: Optional[str]

Scope properties to a specific list/app.

formatuuid
term: Optional[str]
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="deal",
)
print(properties)
{
  "foo": {}
}
Returns Examples
{
  "foo": {}
}