Skip to content
Micro micro
Go to Micro
API Reference
Views

List saved views for an owner

views.list(Literal["comment", "action", "deal", 5 more]object_type, ViewListParams**kwargs) -> ViewListResponse
GET/v2/prism/{teamId}/{objectType}/views

Returns saved view bundles for the path team. Pass ?list_id= to scope to a list (CRM) instead. Cursor pagination matches other Prism list endpoints.

ParametersExpand Collapse
team_id: Optional[str]
formatuuid
object_type: Literal["comment", "action", "deal", 5 more]
One of the following:
"comment"
"action"
"deal"
"engagement"
"document"
"event"
"identity"
"organization"
cursor: Optional[str]

Opaque pagination cursor (from a prior response’s next_cursor); supersedes page/limit when present.

limit: Optional[int]

Maximum items per page (<= 50; defaults to 50).

minimum0
maximum50
list_id: Optional[str]

List (CRM) id to scope the listing to. When omitted, views owned by the path team are returned.

formatuuid
page: Optional[int]

1-based page number. Prefer cursor.

minimum1
ReturnsExpand Collapse
class ViewListResponse: …
data: List[Data]
name: str
view_type: str
id: Optional[str]
formatuuid
aggregation_prop_def_id: Optional[str]
formatuuid
aggregation_type: Optional[str]
column_layout: Optional[Dict[str, object]]
combinator: Optional[Literal["AND", "OR"]]
One of the following:
"AND"
"OR"
created_at: Optional[str]
filter: Optional[List[Dict[str, object]]]

Each entry is { slug: { comparator: value } }

group_by: Optional[str]

Property slug to group by

group_hidden_option_ids: Optional[Union[List[object], object, null]]
One of the following:
List[object]
object
group_hide_empty: Optional[bool]
group_sort: Optional[str]
icon: Optional[str]
list_id: Optional[str]
formatuuid
select: Optional[List[str]]

Property slugs (dot-paths permitted for refs)

sort: Optional[List[Dict[str, object]]]

Each entry is { slug: ‘asc’ | ‘desc’ }

sort_order: Optional[int]
team_id: Optional[str]
formatuuid
updated_at: Optional[str]
user_id: Optional[str]
has_more: bool

True if more views exist beyond this page.

next_cursor: Optional[str]

Opaque cursor for the next page; null when has_more is false.

List saved views for an owner

import os
from micro_so import Micro

client = Micro(
    api_key=os.environ.get("MICRO_API_KEY"),  # This is the default and can be omitted
)
views = client.views.list(
    object_type="comment",
)
print(views.data)
{
  "data": [
    {
      "name": "name",
      "view_type": "view_type",
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "aggregation_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "aggregation_type": "aggregation_type",
      "column_layout": {
        "foo": "bar"
      },
      "combinator": "AND",
      "created_at": "created_at",
      "filter": [
        {
          "foo": "bar"
        }
      ],
      "group_by": "group_by",
      "group_hidden_option_ids": [
        {}
      ],
      "group_hide_empty": true,
      "group_sort": "group_sort",
      "icon": "icon",
      "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "select": [
        "string"
      ],
      "sort": [
        {
          "foo": "bar"
        }
      ],
      "sort_order": 0,
      "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "updated_at",
      "user_id": "user_id"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}
Returns Examples
{
  "data": [
    {
      "name": "name",
      "view_type": "view_type",
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "aggregation_prop_def_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "aggregation_type": "aggregation_type",
      "column_layout": {
        "foo": "bar"
      },
      "combinator": "AND",
      "created_at": "created_at",
      "filter": [
        {
          "foo": "bar"
        }
      ],
      "group_by": "group_by",
      "group_hidden_option_ids": [
        {}
      ],
      "group_hide_empty": true,
      "group_sort": "group_sort",
      "icon": "icon",
      "list_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "select": [
        "string"
      ],
      "sort": [
        {
          "foo": "bar"
        }
      ],
      "sort_order": 0,
      "team_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "updated_at": "updated_at",
      "user_id": "user_id"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}