Skip to content
API Reference
Records

Find object by slug

Returns the single record whose property {slug} equals {value}. 404 if nothing matches; 409 if more than one record matches.

GET/v2/prism/{teamId}/{objectType}/by/{slug}/{value}

Returns the single record whose property {slug} equals {value}. 404 if nothing matches; 409 if more than one record matches.

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
objectType*string

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.

Value in

  • "comment"
  • "deal"
  • "engagement"
  • "identity"
  • "ai_chat_thread"
  • "ai_chat_message"
  • "agent_site"
  • "document"
  • "action"
  • "event"
  • "organization"
  • "contact"
slug*string

Property slug to match (e.g. email).

value*string

Property value to match exactly. URL-encode special characters.

Query Parameters

list_id?string

Scope the lookup to a specific list/app.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/by/${SLUG}/${VALUE}" \  -H "x-api-key: $MICRO_API_KEY"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "extended": {},  "default": {    "property1": null,    "property2": null  },  "list": {}}
micro.so