API Reference

Prism

Properties

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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

objectType PrismPropertyListParamsObjectType

One of the following:

const PrismPropertyListParamsObjectTypeDeal PrismPropertyListParamsObjectType = "deal"

const PrismPropertyListParamsObjectTypeIdentity PrismPropertyListParamsObjectType = "identity"

const PrismPropertyListParamsObjectTypeAIChatThread PrismPropertyListParamsObjectType = "ai_chat_thread"

const PrismPropertyListParamsObjectTypeAIChatMessage PrismPropertyListParamsObjectType = "ai_chat_message"

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

ListID param.Field[string]Optional

Query param: Scope properties to a specific list/app.

formatuuid

Term param.Field[string]Optional

Query param

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

Go

HTTP

TypeScript

Python

Go

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.PrismPropertyListParamsObjectTypeDeal,
    micro.PrismPropertyListParams{

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

200 example

{
  "foo": {}
}

Returns Examples

200 example

{
  "foo": {}
}