Skip to content
API Reference
Records

Count objects

Returns the total number of records of this object type that the caller can see. Avoids the page-overshoot anti-pattern — clients no longer need to keep paging until has_more flips false to discover the total. Currently does not apply query filters; for a filtered total, pass include_total: true in a POST /query body. Unfiltered counts on high-cardinality types (especially engagement) scan the full access-scoped set and can take tens of seconds or time out; prefer a filtered include_total query or accept that this endpoint is expensive there.

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

Returns the total number of records of this object type that the caller can see. Avoids the page-overshoot anti-pattern — clients no longer need to keep paging until has_more flips false to discover the total. Currently does not apply query filters; for a filtered total, pass include_total: true in a POST /query body. Unfiltered counts on high-cardinality types (especially engagement) scan the full access-scoped set and can take tens of seconds or time out; prefer a filtered include_total query or accept that this endpoint is expensive there.

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

list_id?string

Scope the count to a specific list/app.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/comment/count" \  -H "x-api-key: $MICRO_API_KEY"
{  "total": 0}
micro.so