Sign in

v25

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-0131545750.2 KB

Get metadata properties by object type

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

Path parameters

teamIdstring uuid required
objectType'comment' | 'deal' | 'engagement' | 'identity' | 'ai_chat_thread' | 'ai_chat_message' | 'agent_site' | 'document' | 'action' | 'event' | 'organization' | 'contact' required

Query parameters

list_idstring uuid

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.

autofillboolean
boolean
OR
'true' | 'false' | '0' | '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.

termstring

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

Response

OK

MetadataPropertiesResponse required

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.