Skip to content
API Reference
Properties

Get metadata 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.

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.

x-api-key<token>

Public API key generated from Micro settings. Sent as the x-api-key header and validated by AWS API Gateway in front of the service.

In: header

Path Parameters

teamId*string
Formatuuid

Query Parameters

list_id?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
autofill?boolean
include_options?|

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.

term?string

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

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/properties" \  -H "x-api-key: $MICRO_API_KEY"
{  "property1": {},  "property2": {}}
micro.so