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

Get metadata properties by object type

client.Prism.Properties.List(ctx, objectType, params) (*PrismPropertyListResponse, error)
GET/v2/prism/{teamId}/{objectType}/properties

Get metadata properties by object type

ParametersExpand Collapse
One of the following:
const PrismPropertyListParamsObjectTypeComment PrismPropertyListParamsObjectType = "comment"
const PrismPropertyListParamsObjectTypeDeal PrismPropertyListParamsObjectType = "deal"
const PrismPropertyListParamsObjectTypeEngagement PrismPropertyListParamsObjectType = "engagement"
const PrismPropertyListParamsObjectTypeIdentity PrismPropertyListParamsObjectType = "identity"
const PrismPropertyListParamsObjectTypeAIChatThread PrismPropertyListParamsObjectType = "ai_chat_thread"
const PrismPropertyListParamsObjectTypeAIChatMessage PrismPropertyListParamsObjectType = "ai_chat_message"
const PrismPropertyListParamsObjectTypeAgentSite PrismPropertyListParamsObjectType = "agent_site"
const PrismPropertyListParamsObjectTypeDocument PrismPropertyListParamsObjectType = "document"
const PrismPropertyListParamsObjectTypeAction PrismPropertyListParamsObjectType = "action"
const PrismPropertyListParamsObjectTypeEvent PrismPropertyListParamsObjectType = "event"
const PrismPropertyListParamsObjectTypeOrganization PrismPropertyListParamsObjectType = "organization"
const PrismPropertyListParamsObjectTypeContact PrismPropertyListParamsObjectType = "contact"
params PrismPropertyListParams
TeamID param.Field[string]Optional

Path param

formatuuid
Autofill param.Field[bool]Optional

Query param

IncludeOptions param.Field[PrismPropertyListParamsIncludeOptionsUnion]Optional

Query param: 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.

UnionBool
type PrismPropertyListParamsIncludeOptionsString string
One of the following:
const PrismPropertyListParamsIncludeOptionsStringTrue PrismPropertyListParamsIncludeOptionsString = "true"
const PrismPropertyListParamsIncludeOptionsStringFalse PrismPropertyListParamsIncludeOptionsString = "false"
const PrismPropertyListParamsIncludeOptionsString0 PrismPropertyListParamsIncludeOptionsString = "0"
const PrismPropertyListParamsIncludeOptionsString1 PrismPropertyListParamsIncludeOptionsString = "1"
ListID param.Field[string]Optional

Query param: 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 param.Field[string]Optional

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

ReturnsExpand Collapse
type PrismPropertyListResponse map[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.

Get metadata properties by object type

package main

import (
  "context"
  "fmt"

  "github.com/micro-so/micro-sdk-go"
  "github.com/micro-so/micro-sdk-go/option"
)

func main() {
  client := micro.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithTeamID("My Team ID"),
  )
  properties, err := client.Prism.Properties.List(
    context.TODO(),
    micro.PrismPropertyListParamsObjectTypeComment,
    micro.PrismPropertyListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", properties)
}

{
  "foo": {}
}
Returns Examples
{
  "foo": {}
}