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

Get metadata properties by object type

GET/v2/prism/{teamId}/{objectType}/properties

Get metadata properties by object type

Path ParametersExpand Collapse
teamId: optional string
formatuuid
objectType: "comment" or "deal" or "engagement" or 9 more
One of the following:
"comment"
"deal"
"engagement"
"identity"
"ai_chat_thread"
"ai_chat_message"
"agent_site"
"document"
"action"
"event"
"organization"
"contact"
Query ParametersExpand Collapse
autofill: optional boolean
include_options: optional boolean or "true" or "false" or "0" or "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:
boolean
"true" or "false" or "0" or "1"
One of the following:
"true"
"false"
"0"
"1"
list_id: optional string

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 string

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

Get metadata properties by object type

curl https://developers.micro.so/v2/prism/$TEAM_ID/$OBJECT_TYPE/properties \
    -H "x-api-key: $MICRO_API_KEY"
{
  "foo": {}
}
Returns Examples
{
  "foo": {}
}