Query records
Query records with an API key and team ID. Select, filter, sort, and paginate records. Set include_total only when a count is needed, and pass next_cursor back unchanged while has_more is true.
/v2/prism/{teamId}/{objectType}/queryAuthorization
apiKey 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
uuidQueryable object type. Same set as ObjectType (CRUD). GET /v2/prism/{teamId}/properties also returns metadata for pipeline-owned types such as message that are not in this set and cannot be queried. Contacts expose last_email as a ref_message; you cannot follow it with a message query.
Value in
- "comment"
- "deal"
- "engagement"
- "identity"
- "ai_chat_thread"
- "ai_chat_message"
- "agent_site"
- "document"
- "action"
- "event"
- "organization"
- "contact"
Header Parameters
A unique key (UUID or any opaque string up to 255 chars) for an authenticated POST, PUT, or PATCH request. The server retains the initial claim for 24 hours and replays a completed non-5xx response only when the method, path, and request body all match. Reusing a non-expired key with a different method, path, or body returns 409 idempotency_key_mismatch; reusing it after expiry returns 409 idempotency_key_stale, so use a new key. Replays include the idempotent-replay: true response header.
1 <= length <= 255Request Body
application/json
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://developers.micro.so/v2/prism/${MICRO_TEAM_ID}/contact/query" \ -H "x-api-key: $MICRO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "query": { "select": [ "full_name", "email", "title", "organization" ], "filter": [ { "full_name": { "=": "Sarah Chen" } } ], "limit": 10 }, "include_total": true }'{ "data": [ { "id": "11111111-1111-4111-8111-111111111111", "properties": { "full_name": "Sarah Chen", "email": "sarah@example.com", "title": "Partner", "organization": "Acme Ventures" }, "is_user_object": false, "source": null } ], "has_more": false, "next_cursor": null, "total": 1}