v1

latestOpenAPI 3.0.0Proprietary2026-08-062711471.0 MB

Object views

Create view

Creates a saved view on an object. Requires a USER API key.

post/public/v1/objects/{name}/views

Path parameters

namestring required

Example:deals

Request body

namestring required

type'TABLE' | 'KANBAN' | 'RECORD' required

Example request

{
  "name": "example",
  "type": "TABLE",
  "metadata": {
    "grouping_field_id": 1,
    "groupingColumnId": 1,
    "column_order": [
      "example"
    ],
    "columnOrder": [
      "example"
    ],
    "hidden_columns": [
      "example"
    ],
    "hiddenColumns": [
      "example"
    ],
    "dialog_field_order": [
      "example"
    ],
    "dialogFieldOrder": [
      "example"
    ],
    "sticky_columns": [
      "example"
    ],
    "stickyColumns": [
      "example"
    ],
    "kanban_lane_size": "THIN",
    "kanbanLaneSize": "THIN"
  }
}

Response

Created view

oktrue required

Example response

{
  "ok": true,
  "data": {
    "id": 1,
    "name": "example",
    "type": "TABLE",
    "record_type_id": 1,
    "created_at": "example",
    "updated_at": "example",
    "column_order": [
      "example"
    ],
    "hidden_columns": [
      "example"
    ],
    "sticky_columns": [
      "example"
    ],
    "grouping_field_id": 1,
    "title_field_id": 1,
    "display_field_ids": [
      1
    ]
  }
}