API Reference

Views

Records

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List records selected by a view (filters and sorts applied; pinned record_order overlaid first)

views.records.list(strview_id, RecordListParams**kwargs) -> RecordListResponse

GET/v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records

List records selected by a view (filters and sorts applied; pinned record_order overlaid first)

ParametersExpand Collapse

team_id: Optional[str]

formatuuid

view_object_type: Literal["action", "deal", "document", 3 more]

One of the following:

"action"

"deal"

"document"

"event"

"identity"

"organization"

view_id: str

formatuuid

cursor: Optional[str]

Opaque cursor from a previous response’s next_cursor. Pass it back unchanged to fetch the next page. When set, page and limit are derived from the cursor.

limit: Optional[int]

minimum0

maximum50

page: Optional[int]

Page number (1-based). Prefer cursor.

minimum1

ReturnsExpand Collapse

class RecordListResponse: …

data: List[Dict[str, object]]

has_more: bool

True if more records exist beyond this page.

next_cursor: Optional[str]

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

List records selected by a view (filters and sorts applied; pinned record_order overlaid first)

Python

HTTP

TypeScript

Python

Go

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
)
records = client.views.records.list(
    view_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    view_object_type="action",
)
print(records.data)

200 example

{
  "data": [
    {
      "foo": "bar"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}

Returns Examples

200 example

{
  "data": [
    {
      "foo": "bar"
    }
  ],
  "has_more": true,
  "next_cursor": "next_cursor"
}