# Get metadata properties by object type **Endpoint:** `GET /v2/prism/{teamId}/{objectType}/properties` **Operation ID:** `getMetadataPropertiesByObjectType` **Server:** `https://developers.micro.so` **Security:** `[{"apiKey":[]}]` ## Parameters ```json [ { "name": "teamId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "objectType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ObjectType" } }, { "name": "list_id", "in": "query", "description": "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.", "schema": { "type": "string", "format": "uuid" } }, { "name": "autofill", "in": "query", "schema": { "type": "boolean" } }, { "name": "include_options", "in": "query", "description": "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.", "schema": { "anyOf": [ { "type": "boolean" }, { "type": "string", "enum": [ "true", "false", "0", "1" ] } ] } }, { "name": "term", "in": "query", "description": "Case-insensitive substring match on the property name. Use this to find an existing property before creating a new one.", "schema": { "type": "string" } } ] ``` ## Request body ```json null ``` ## Responses ```json { "200": { "description": "OK", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MetadataPropertiesResponse" } } } }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "500": { "$ref": "#/components/responses/InternalError" } } ``` ## Referenced components ```json { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "x-api-key", "description": "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." } }, "schemas": { "ObjectType": { "type": "string", "description": "Object types that support CRUD, query, list, and per-type property metadata. `GET /v2/prism/{teamId}/properties` (list-all) also returns definitions for pipeline-owned types that are not in this set — including `message`, `thread`, and `linkedin_thread`. Those types are not queryable. Contacts expose `last_email` as a `ref_message`; you cannot query `message` to follow it.", "enum": [ "comment", "deal", "engagement", "identity", "ai_chat_thread", "ai_chat_message", "agent_site", "document", "action", "event", "organization", "contact" ] }, "MetadataPropertiesResponse": { "type": "object", "description": "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.", "additionalProperties": { "type": "object", "description": "Property definitions for one object type, keyed by property definition id (UUID).", "patternProperties": { "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$": { "$ref": "#/components/schemas/PropertyDefinition" } }, "additionalProperties": false } }, "PropertyDefinition": { "type": "object", "description": "Definition for a single property on an object type. Definitions with team_id and crm_id null are shared defaults; values may be scoped to a team and/or list (crm).", "required": [ "id", "slug", "type" ], "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "type": { "$ref": "#/components/schemas/PropertyType" }, "team_id": { "type": [ "string", "null" ], "format": "uuid" }, "crm_id": { "type": [ "string", "null" ], "format": "uuid", "description": "Identifier of the list this definition is scoped to, when applicable." }, "list_id": { "type": [ "string", "null" ], "format": "uuid", "description": "Canonical identifier of the list this definition is scoped to." }, "native": { "type": "boolean" }, "locked": { "type": "boolean" }, "alias": { "type": [ "string", "null" ], "enum": [ "app_stage", null ], "description": "Reserved alias naming this definition, or null. `app_stage` marks the list pipeline stage definition. Resolve stages by this field rather than by name, slug, or team_id: a superseded native `status` definition can coexist with the pipeline one and is otherwise identical on the wire." }, "required": { "type": "boolean", "description": "When true, records of this object type must carry a non-empty value for this property on create, and a patch may not clear it." }, "role_id": { "type": [ "string", "null" ], "format": "uuid", "description": "The property's display format. Always populated on definitions created through this API; a null here means the definition predates that and will render as an unknown format until it is patched." }, "options": { "type": "array", "description": "Present only for select_str and multiselect_str types.", "items": { "$ref": "#/components/schemas/PropertyOption" } } }, "additionalProperties": false }, "Error": { "type": "object", "description": "Canonical JSON error envelope for every non-2xx v2 API response. `error.code` is the machine-readable error code, `error.message` is the human-readable summary, and `error.request_id` identifies the request for support. When supplied, `error.errors` contains field-level validation issues.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "request_id" ], "properties": { "code": { "type": "string", "description": "Stable machine-readable code. Branch on this, not on the HTTP status, to handle specific failure modes.", "example": "invalid_request" }, "message": { "type": "string", "description": "Human-readable summary suitable for logs. Not localized; do not display verbatim to end users." }, "request_id": { "type": [ "string", "null" ], "description": "Echo of the x-request-id response header. Include in support requests." }, "errors": { "type": "array", "description": "Optional structured field-level validation issues when the server provides them.", "items": { "type": "object", "properties": { "field": { "type": "string", "description": "JSON path of the offending property (e.g. \".body.default.email\")." }, "message": { "type": "string" }, "code": { "type": "string", "description": "Validator-specific code (e.g. \"required.openapi.validation\")." } }, "required": [ "message" ] } }, "details": { "type": "object", "description": "Optional bag of error-specific context. Shape varies by code; clients should treat fields as opaque unless documented." } } } } }, "PropertyType": { "type": "string", "description": "Storage type for a property definition. Determines which per-type table holds the values, and which display formats the property can take.", "enum": [ "num", "str", "bool", "date", "text", "byte", "select_str", "multi_str", "multiselect_str", "jsonb", "ref_identity", "ref_user", "ref_organization", "ref_contact", "ref_thread", "ref_message", "ref_event", "ref_account", "ref_ai_chat_thread", "ref_ai_chat_message", "multiref_ai_chat_message", "multiref_agent_site", "multiref_action", "multiref_comment", "multiref_contact", "multiref_label", "multiref_thread", "multiref_messages", "multiref_document", "multiref_identity", "multiref_organization", "multiref_engagement", "multiref_attendee", "multiref_meeting_entry", "multiref_read_receipt", "multiref_account", "multiref_source" ] }, "PropertyOption": { "type": "object", "description": "An enabled option for a select_str or multiselect_str property definition.", "required": [ "id", "slug" ], "properties": { "id": { "type": "string", "format": "uuid" }, "slug": { "type": "string" }, "value": { "type": [ "string", "null" ], "description": "Display value for the option." }, "color_scheme": { "type": [ "string", "null" ] }, "sort_index": { "type": [ "integer", "null" ] }, "icon": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "option_group": { "type": [ "string", "null" ] }, "list_id": { "type": [ "string", "null" ], "format": "uuid" }, "crm_id": { "type": [ "string", "null" ], "format": "uuid", "deprecated": true } }, "additionalProperties": false } }, "headers": { "XRequestId": { "description": "Correlation ID. Echoed from the request `x-request-id` header when supplied, otherwise generated. Include in support requests.", "schema": { "type": "string" } } }, "responses": { "Unauthorized": { "description": "Missing or invalid credentials. API Gateway maps a missing or invalid `x-api-key` to HTTP 401 with this envelope (including `request_id`). A 403 here means the key was accepted but the caller is not permitted.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "Forbidden": { "description": "Authenticated but not permitted to perform this action.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "InternalError": { "description": "Unexpected server error. Retry with backoff; report `request_id` if persistent.", "headers": { "x-request-id": { "$ref": "#/components/headers/XRequestId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } ```