Skip to content
Go to Micro

List records of an object type

GET/v2/prism/{teamId}/event

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.

Path ParametersExpand Collapse
teamId: optional string
formatuuid
Query ParametersExpand Collapse
cursor: optional string

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

deleted: optional boolean

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

include_total: optional 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.

limit: optional number

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

minimum1
maximum50
list_id: optional string

Scope properties to a specific list/app.

formatuuid
select: optional string

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

sort: optional string

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

ReturnsExpand Collapse
data: array of object { id, is_user_object, properties, source }
id: string
formatuuid
is_user_object: optional boolean
properties: optional map[unknown]

Selected property values keyed by property slug. For select/multiselect properties, option slugs are returned. For reference properties, values are nested { id, properties } objects.

source: optional array of string
has_more: boolean

Accurate end-of-data signal — false on the last page, never forces clients to overshoot.

next_cursor: optional string
total: optional number

Populated only when ?include_total=true was passed.

List records of an object type

curl https://developers.micro.so/v2/prism/$TEAM_ID/event \
    -H "x-api-key: $MICRO_API_KEY"
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "is_user_object": true,
      "properties": {
        "foo": "bar"
      },
      "source": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor",
  "total": 0
}
Returns Examples
{
  "data": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "is_user_object": true,
      "properties": {
        "foo": "bar"
      },
      "source": [
        "string"
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor",
  "total": 0
}