Views

Create a table view

Changed on

Creates a view owned by your API key's user. visibility defaults to private and isCollaborative to false. filters and columns are page-defined: Atlas stores them as given and does not validate them, so a view built from invented keys will load empty in the app. Read an existing view of the same pageType first and copy its shape.

post/api/v1/table-views

Request

Request body

namestring required

View name

pageType'people' | 'companyContacts' | 'companies' required

Page the view belongs to

filtersobject

Saved filter state. Opaque JSON whose shape is defined by the page, not validated here — copy it from an existing view of the same pageType

visibility'public' | 'team' | 'private'

Defaults to private when omitted

isCollaborativeboolean

Whether other users who can see a shared view may change it. Defaults to false when omitted

Example request

{
  "name": "London engineers",
  "pageType": "people",
  "columns": {
    "visibility": {
      "firstName": true,
      "currentRate": false
    },
    "order": [
      "firstName",
      "lastName"
    ]
  },
  "sorting": [
    {
      "id": "lastName",
      "direction": "asc"
    }
  ],
  "visibility": "team"
}

Response

Table view created

status'ok' required

Changes