API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Views

Create a view bundle (view + select/filter/sort)

views.create(Literal["action", "deal", "document", 3 more]view_object_type, ViewCreateParams**kwargs) -> ViewCreateResponse

POST/v2/prism/{teamId}/{viewObjectType}/views

Read a view bundle

views.get(strview_id, ViewGetParams**kwargs) -> ViewGetResponse

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

Update a view bundle (select/filter/sort arrays are replaced wholesale when supplied)

views.update(strview_id, ViewUpdateParams**kwargs) -> ViewUpdateResponse

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

Delete a view bundle

views.delete(strview_id, ViewDeleteParams**kwargs)

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

ModelsExpand Collapse

class ViewCreateResponse: …

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

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]

ViewGetResponse

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

One of the following:

class ViewBundle: …

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

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]

class ViewBundleWithRecords: …

Returned by GET /views/{viewId}?include=records. Same records shape as the standalone list-view-records endpoint.

records: ViewBundleWithRecordsRecords

data: List[Dict[str, object]]

has_more: bool

next_cursor: Optional[str]

view: ViewBundleWithRecordsView

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

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]

class ViewUpdateResponse: …

A view (saved configuration for displaying records of a given object type) plus its select/filter/sort children. Properties in select/filter/sort are referenced by slug.

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]

ViewsRecords

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

Bulk reorder pinned records

views.records.reorder(strview_id, RecordReorderParams**kwargs)

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

Pin a record to the view (append to record_order)

views.records.pin(strobject_id, RecordPinParams**kwargs)

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

Unpin a record from the view

views.records.unpin(strobject_id, RecordUnpinParams**kwargs)

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

ModelsExpand 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.