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)

client.views.create("action" | "deal" | "document" | 3 moreviewObjectType, ViewCreateParams { teamId, name, view_type, 20 more } params, RequestOptionsoptions?): ViewCreateResponse { name, view_type, id, 18 more }

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

Read a view bundle

client.views.get(stringviewID, ViewGetParams { teamId, viewObjectType, cursor, 3 more } params, RequestOptionsoptions?): ViewGetResponse

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

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

client.views.update(stringviewID, ViewUpdateParams { teamId, viewObjectType, aggregation_prop_def_id, 18 more } params, RequestOptionsoptions?): ViewUpdateResponse { name, view_type, id, 18 more }

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

Delete a view bundle

client.views.delete(stringviewID, ViewDeleteParams { teamId, viewObjectType } params, RequestOptionsoptions?): void

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

ModelsExpand Collapse

ViewCreateResponse { 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?: string

formatuuid

aggregation_prop_def_id?: string | null

formatuuid

aggregation_type?: string | null

column_layout?: Record<string, unknown> | null

combinator?: "AND" | "OR"

One of the following:

"AND"

"OR"

created_at?: string

filter?: Array<Record<string, unknown>>

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

group_by?: string | null

Property slug to group by

group_hidden_option_ids?: Array<unknown> | unknown | null

One of the following:

Array<unknown>

unknown

group_hide_empty?: boolean | null

group_sort?: string | null

icon?: string | null

list_id?: string | null

formatuuid

select?: Array<string>

Property slugs (dot-paths permitted for refs)

sort?: Array<Record<string, unknown>>

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

sort_order?: number | null

team_id?: string | null

formatuuid

updated_at?: string | null

user_id?: string | null

ViewGetResponse = ViewBundle { name, view_type, id, 18 more } | ViewBundleWithRecords { 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 { 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?: string

formatuuid

aggregation_prop_def_id?: string | null

formatuuid

aggregation_type?: string | null

column_layout?: Record<string, unknown> | null

combinator?: "AND" | "OR"

One of the following:

"AND"

"OR"

created_at?: string

filter?: Array<Record<string, unknown>>

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

group_by?: string | null

Property slug to group by

group_hidden_option_ids?: Array<unknown> | unknown | null

One of the following:

Array<unknown>

unknown

group_hide_empty?: boolean | null

group_sort?: string | null

icon?: string | null

list_id?: string | null

formatuuid

select?: Array<string>

Property slugs (dot-paths permitted for refs)

sort?: Array<Record<string, unknown>>

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

sort_order?: number | null

team_id?: string | null

formatuuid

updated_at?: string | null

user_id?: string | null

ViewBundleWithRecords { records, view }

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

records: Records { data, has_more, next_cursor }

data: Array<Record<string, unknown>>

has_more: boolean

next_cursor?: string | null

view: View { 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?: string

formatuuid

aggregation_prop_def_id?: string | null

formatuuid

aggregation_type?: string | null

column_layout?: Record<string, unknown> | null

combinator?: "AND" | "OR"

One of the following:

"AND"

"OR"

created_at?: string

filter?: Array<Record<string, unknown>>

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

group_by?: string | null

Property slug to group by

group_hidden_option_ids?: Array<unknown> | unknown | null

One of the following:

Array<unknown>

unknown

group_hide_empty?: boolean | null

group_sort?: string | null

icon?: string | null

list_id?: string | null

formatuuid

select?: Array<string>

Property slugs (dot-paths permitted for refs)

sort?: Array<Record<string, unknown>>

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

sort_order?: number | null

team_id?: string | null

formatuuid

updated_at?: string | null

user_id?: string | null

ViewUpdateResponse { 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?: string

formatuuid

aggregation_prop_def_id?: string | null

formatuuid

aggregation_type?: string | null

column_layout?: Record<string, unknown> | null

combinator?: "AND" | "OR"

One of the following:

"AND"

"OR"

created_at?: string

filter?: Array<Record<string, unknown>>

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

group_by?: string | null

Property slug to group by

group_hidden_option_ids?: Array<unknown> | unknown | null

One of the following:

Array<unknown>

unknown

group_hide_empty?: boolean | null

group_sort?: string | null

icon?: string | null

list_id?: string | null

formatuuid

select?: Array<string>

Property slugs (dot-paths permitted for refs)

sort?: Array<Record<string, unknown>>

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

sort_order?: number | null

team_id?: string | null

formatuuid

updated_at?: string | null

user_id?: string | null

ViewsRecords

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

client.views.records.list(stringviewID, RecordListParams { teamId, viewObjectType, cursor, 2 more } params, RequestOptionsoptions?): RecordListResponse { data, has_more, next_cursor }

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

Bulk reorder pinned records

client.views.records.reorder(stringviewID, RecordReorderParams { teamId, viewObjectType, object_ids, idempotencyKey } params, RequestOptionsoptions?): void

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

Pin a record to the view (append to record_order)

client.views.records.pin(stringobjectID, RecordPinParams { teamId, viewObjectType, viewId, idempotencyKey } params, RequestOptionsoptions?): void

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

Unpin a record from the view

client.views.records.unpin(stringobjectID, RecordUnpinParams { teamId, viewObjectType, viewId } params, RequestOptionsoptions?): void

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

ModelsExpand Collapse

RecordListResponse { data, has_more, next_cursor }

data: Array<Record<string, unknown>>

has_more: boolean

True if more records exist beyond this page.

next_cursor?: string | null

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