Skip to content
API Reference
Records

List objects

Convenience list endpoint. Equivalent to POST /v2/prism/{teamId}/{objectType}/query with an empty body, plus query-string sugar for the common cases. Any unrecognized query parameter is interpreted as an equality filter on a property of that name; pass arrays for in. Values are received as strings, so non-string property filters via this endpoint may not work — use the query endpoint for typed comparisons or anything beyond simple equality.

GET/v2/prism/{teamId}/{objectType}

Convenience list endpoint. Equivalent to POST /v2/prism/{teamId}/{objectType}/query with an empty body, plus query-string sugar for the common cases. Any unrecognized query parameter is interpreted as an equality filter on a property of that name; pass arrays for in. Values are received as strings, so non-string property filters via this endpoint may not work — use the query endpoint for typed comparisons or anything beyond simple equality.

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"

Query Parameters

cursor?string

Opaque cursor from a previous response's next_cursor. Pass it back unchanged to fetch the next page.

limit?integer

Maximum number of rows to return. Capped server-side at 50.

Range1 <= value <= 50
sort?string

Comma-separated list of slugs. Prefix with - for descending. Example: sort=-updated_at,name.

select?string

Comma-separated property slugs to return. Use dot notation for relationships. id is always returned at the top level. Defaults to all properties.

list_id?string

Scope properties to a specific list/app.

Formatuuid
deleted?boolean

Include soft-deleted records. Pass the literal string true.

include_total?boolean

When set to true, the response includes a total field with the unpaginated row count. Costs an extra pass; prefer GET .../count for the unfiltered total.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment" \  -H "x-api-key: $MICRO_API_KEY"
{  "data": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "properties": {        "property1": null,        "property2": null      },      "is_user_object": true,      "source": [        "string"      ]    }  ],  "has_more": true,  "next_cursor": "string",  "total": 0}
micro.so