Skip to content
API Reference
Lists and views

View records

View records in Views — Micro Python reference.

Reference for Python SDK 0.8.0.

Release source · Setup and client configuration

list

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

client.views.records.list(view_id, *, team_id, view_object_type, **params) -> RecordListResponse

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

pin

POST /v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records/{objectId}

client.views.records.pin(object_id, *, team_id, view_object_type, view_id) -> None

Pin a record to the view (append to record_order)

reorder

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

client.views.records.reorder(view_id, *, team_id, view_object_type, **params) -> None

Bulk reorder pinned records

unpin

DELETE /v2/prism/{teamId}/{viewObjectType}/views/{viewId}/records/{objectId}

client.views.records.unpin(object_id, *, team_id, view_object_type, view_id) -> None

Unpin a record from the view

Parameter and response types

These declarations show the request parameters and response shapes used by the methods above.

RecordListParams

Source

FieldTypeRequiredDescription
team_idstrNoAPI name: teamId.
view_object_typeRequired[Yes
cursorstrNoOpaque 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.
limitintNo
pageintNoPage number (1-based). Prefer cursor.

RecordListResponse

Source

FieldTypeRequiredDescription
dataList[Dict[str, object]]Yes
has_moreboolYesTrue if more records exist beyond this page.
next_cursorOptional[str]NoOpaque cursor for the next page; null when has_more is false.

RecordReorderParams

Source

FieldTypeRequiredDescription
team_idstrNoAPI name: teamId.
view_object_typeRequired[Yes
object_idsRequired[SequenceNotStr[str]]Yes
idempotency_keystrNoAPI name: Idempotency-Key.
micro.so