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)

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

Read a view bundle

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

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

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

Delete a view bundle

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

ModelsExpand Collapse

ViewCreateResponse object { name, view_type, id, 18 more }

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: string

view_type: string

id: optional string

formatuuid

aggregation_prop_def_id: optional string

formatuuid

aggregation_type: optional string

column_layout: optional map[unknown]

combinator: optional "AND" or "OR"

One of the following:

"AND"

"OR"

created_at: optional string

filter: optional array of map[unknown]

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

group_by: optional string

Property slug to group by

group_hidden_option_ids: optional array of unknown or unknown

One of the following:

array of unknown

unknown

group_hide_empty: optional boolean

group_sort: optional string

icon: optional string

list_id: optional string

formatuuid

select: optional array of string

Property slugs (dot-paths permitted for refs)

sort: optional array of map[unknown]

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

sort_order: optional number

team_id: optional string

formatuuid

updated_at: optional string

user_id: optional string

ViewGetResponse = object { name, view_type, id, 18 more } or object { records, view }

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:

ViewBundle object { name, view_type, id, 18 more }

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: string

view_type: string

id: optional string

formatuuid

aggregation_prop_def_id: optional string

formatuuid

aggregation_type: optional string

column_layout: optional map[unknown]

combinator: optional "AND" or "OR"

One of the following:

"AND"

"OR"

created_at: optional string

filter: optional array of map[unknown]

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

group_by: optional string

Property slug to group by

group_hidden_option_ids: optional array of unknown or unknown

One of the following:

array of unknown

unknown

group_hide_empty: optional boolean

group_sort: optional string

icon: optional string

list_id: optional string

formatuuid

select: optional array of string

Property slugs (dot-paths permitted for refs)

sort: optional array of map[unknown]

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

sort_order: optional number

team_id: optional string

formatuuid

updated_at: optional string

user_id: optional string

ViewBundleWithRecords object { records, view }

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

records: object { data, has_more, next_cursor }

data: array of map[unknown]

has_more: boolean

next_cursor: optional string

view: object { name, view_type, id, 18 more }

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: string

view_type: string

id: optional string

formatuuid

aggregation_prop_def_id: optional string

formatuuid

aggregation_type: optional string

column_layout: optional map[unknown]

combinator: optional "AND" or "OR"

One of the following:

"AND"

"OR"

created_at: optional string

filter: optional array of map[unknown]

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

group_by: optional string

Property slug to group by

group_hidden_option_ids: optional array of unknown or unknown

One of the following:

array of unknown

unknown

group_hide_empty: optional boolean

group_sort: optional string

icon: optional string

list_id: optional string

formatuuid

select: optional array of string

Property slugs (dot-paths permitted for refs)

sort: optional array of map[unknown]

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

sort_order: optional number

team_id: optional string

formatuuid

updated_at: optional string

user_id: optional string

ViewUpdateResponse object { name, view_type, id, 18 more }

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: string

view_type: string

id: optional string

formatuuid

aggregation_prop_def_id: optional string

formatuuid

aggregation_type: optional string

column_layout: optional map[unknown]

combinator: optional "AND" or "OR"

One of the following:

"AND"

"OR"

created_at: optional string

filter: optional array of map[unknown]

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

group_by: optional string

Property slug to group by

group_hidden_option_ids: optional array of unknown or unknown

One of the following:

array of unknown

unknown

group_hide_empty: optional boolean

group_sort: optional string

icon: optional string

list_id: optional string

formatuuid

select: optional array of string

Property slugs (dot-paths permitted for refs)

sort: optional array of map[unknown]

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

sort_order: optional number

team_id: optional string

formatuuid

updated_at: optional string

user_id: optional string

ViewsRecords

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

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

Bulk reorder pinned records

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

Pin a record to the view (append to record_order)

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

Unpin a record from the view

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

ModelsExpand Collapse

RecordListResponse object { data, has_more, next_cursor }

data: array of map[unknown]

has_more: boolean

True if more records exist beyond this page.

next_cursor: optional string

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