Skip to content

Saved Views

GET    /api/views
GET    /api/views/{id}
POST   /api/views
PUT    /api/views/{id}
DELETE /api/views/{id}

Authentication required.

Saved Views let users persist custom column selections, filter configurations, and sort settings for any table in the application. Views are per-user by default; use the Shared Views endpoints to share with other users.


View Object

{
  "id": 301,
  "name": "My Open POs",
  "view": "purchase_order_list",
  "headers": ["PO List Number", "Supplier Name", "PO List Document Status"],
  "filters": {
    "PO List Document Status": "Open"
  },
  "sort": {
    "key": "PO List Order Date",
    "type": "Descending"
  },
  "tags": {},
  "extra": {}
}
Field Type Description
id integer Internal view identifier
name string Display name - must be unique per user per view type
view string View type identifier (e.g., purchase_order_list)
headers array | null Selected column keys to display
filters object | null Saved filter configuration
sort object | null Saved sort configuration
tags object Additional metadata
extra object Additional contextual data

GET - List Views

curl -b cookies.txt "https://acme.knosc.com/api/views"

POST - Create View

POST /api/views HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "name": "My Open POs",
  "view": "purchase_order_list",
  "filters": { "PO List Document Status": "Open" },
  "sort": { "key": "PO List Order Date", "type": "Descending" }
}

Validation: name must be unique per user per view type.


PUT - Update View

PUT /api/views/{id} HTTP/1.1
Content-Type: application/json
X-XSRF-TOKEN: <csrf>

{
  "filters": { "PO List Document Status": "Shipped" }
}

DELETE - Delete View

DELETE /api/views/{id} HTTP/1.1
X-XSRF-TOKEN: <csrf>

Shared Views

GET    /api/views-shared
GET    /api/views-shared/{id}
POST   /api/views-shared
PUT    /api/views-shared/{id}
DELETE /api/views-shared/{id}

Same schema and behaviour as personal views, but visible to all users with access to the same view type. Create a shared view to distribute a standard configuration across your team.