Skip to main content
Views are saved configurations for displaying records. A list view shows a table. A board view shows a kanban. Both support filters, sorting, column visibility, and grouping.

​
Tools

ToolDescriptionKey Params
views.listList all views in the workspaceobject_type_slug (optional), list_id (optional)
views.getGet a single view’s configurationview_id
views.createCreate a new viewname, object_type_slug, view_type, config, list_id
views.updateUpdate a view’s config (filters, sort, columns)view_id, config
views.deleteDelete a viewview_id
views.dataFetch records using a view’s saved configview_id, page, page_size

​
View Types

TypeDescription
listTable view with sortable columns
boardKanban board grouped by a select field

​
Examples

​
Create a board view grouped by stage

{
  "tool": "views.create",
  "params": {
    "name": "Deal Board",
    "object_type_slug": "deals",
    "view_type": "board",
    "list_id": "lst_abc123",
    "config": {
      "group_by": "Stage",
      "columns": ["Name", "Deal Value", "Expected Close"],
      "sort": [{ "field": "Deal Value", "direction": "desc" }]
    }
  }
}

​
Create a filtered list view

{
  "tool": "views.create",
  "params": {
    "name": "High-Value Open Deals",
    "object_type_slug": "deals",
    "view_type": "list",
    "list_id": "lst_abc123",
    "config": {
      "columns": ["Name", "Deal Value", "Stage", "Expected Close"],
      "filters": [
        { "field": "Deal Value", "operator": "gte", "value": 50000 },
        { "field": "Stage", "operator": "not_in", "value": ["Closed Won", "Closed Lost"] }
      ],
      "sort": [{ "field": "Deal Value", "direction": "desc" }]
    }
  }
}

​
Fetch data through a view

{
  "tool": "views.data",
  "params": {
    "view_id": "view_xyz789",
    "page": 1,
    "page_size": 50
  }
}