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

Get metadata properties

client.Prism.Properties.ListAll(ctx, params) (*PrismPropertyListAllResponse, error)
GET/v2/prism/{teamId}/properties

Lists property definitions across every object type the engine knows about, including pipeline-owned types that are not queryable or CRUD-capable (message, thread, linkedin_thread, and others). Only the ObjectType enum (12 types) can be queried, created, updated, or listed. Contacts point at message via last_email; that relationship cannot be followed with /query.

ParametersExpand Collapse
params PrismPropertyListAllParams
TeamID param.Field[string]Optional

Path param

formatuuid
Autofill param.Field[bool]Optional

Query param

IncludeOptions param.Field[PrismPropertyListAllParamsIncludeOptionsUnion]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 PrismPropertyListAllParamsIncludeOptionsString string
One of the following:
const PrismPropertyListAllParamsIncludeOptionsStringTrue PrismPropertyListAllParamsIncludeOptionsString = "true"
const PrismPropertyListAllParamsIncludeOptionsStringFalse PrismPropertyListAllParamsIncludeOptionsString = "false"
const PrismPropertyListAllParamsIncludeOptionsString0 PrismPropertyListAllParamsIncludeOptionsString = "0"
const PrismPropertyListAllParamsIncludeOptionsString1 PrismPropertyListAllParamsIncludeOptionsString = "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 PrismPropertyListAllResponse 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

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"),
  )
  response, err := client.Prism.Properties.ListAll(context.TODO(), micro.PrismPropertyListAllParams{

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

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