Views API

Manage table views using NocoDB API

Overview

Views in NocoDB allow you to display and organize table data in different ways. Each view can have its own filters, sorts, column visibility, and display settings.

View Types

NocoDB supports multiple view types:

• Grid (type: 3): Traditional spreadsheet-style view
• Gallery (type: 2): Card-based view for visual data
• Form (type: 1): Form view for data entry
• Kanban (type: 4): Kanban board for project management
• Calendar (type: 5): Calendar view for date-based data
• Map: Geographic visualization
• List: List view for mobile-friendly display

List Views

Retrieve all views for a specific table.

curl -X GET "https://app.nocodb.com/api/v1/db/meta/tables/{tableId}/views" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

tableId · string · required

Unique identifier for the table

Response

list · array

Array of view objects

list[].id · string

Unique view identifier

list[].title · string

Display title of the view

list[].type · number

View type: 1 (Form), 2 (Gallery), 3 (Grid), 4 (Kanban), 5 (Calendar)

list[].fk_model_id · string

Foreign key to the table this view belongs to

list[].order · number

Display order of the view

list[].show · boolean

Whether this view is visible

list[].lock_type · string

Lock type: collaborative, locked, or personal

pageInfo · object

Pagination information

Update View

Update a view’s properties.

curl -X PATCH "https://app.nocodb.com/api/v1/db/meta/views/{viewId}" \
  -H "xc-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Updated View Title",
    "lock_type": "collaborative",
    "show_system_fields": false
  }'

Path Parameters

viewId · string · required

Unique identifier for the view

Request Body

title · string

New display title for the view

lock_type · string

Lock type: collaborative, locked, or personal

show_system_fields · boolean

Whether to show system fields (CreatedAt, UpdatedAt, etc.)

order · number

Display order of the view

show · boolean

Whether the view is visible

meta · object

Additional metadata (e.g., {"allowCSVDownload": true})

password · string

Password for protecting the view (when shared)

description · string

View description (max 8192 characters)

Example Response

{
  "id": "vw_lg052cnc1c26kf",
  "title": "Updated View Title",
  "type": 3,
  "fk_model_id": "md_mhs9z4r2ak98x0",
  "lock_type": "collaborative",
  "show": 1,
  "order": 1,
  "base_id": "p_xm3thidrblw4n7",
  "created_at": "2023-03-02 17:46:31",
  "updated_at": "2023-03-02 18:30:15"
}

Delete View

Delete a view from a table.

curl -X DELETE "https://app.nocodb.com/api/v1/db/meta/views/{viewId}" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

viewId · string · required

Unique identifier for the view to delete

Response

success · boolean

Returns true if deletion was successful

Deleting a view will remove all its filters, sorts, and column visibility settings. This action cannot be undone.

Show All Columns

Make all columns visible in a view.

curl -X POST "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/show-all" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

viewId · string · required

Unique identifier for the view

Query Parameters

ignoreIds · array

Array of column IDs to exclude from showing

Example

curl -X POST "https://app.nocodb.com/api/v1/db/meta/views/vw_abc123/show-all?ignoreIds=cl_xyz789&ignoreIds=cl_def456" \
  -H "xc-token: YOUR_API_TOKEN"

Hide All Columns

Hide all columns in a view.

curl -X POST "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/hide-all" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

viewId · string · required

Unique identifier for the view

Query Parameters

ignoreIds · array

Array of column IDs to exclude from hiding (keep visible)

System columns and primary key columns are typically excluded from hide-all operations.

Share View

Create a shared link for a view.

curl -X POST "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/share" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

viewId · string · required

Unique identifier for the view

Response

uuid · string

Unique identifier for the shared view

url · string

Public URL for accessing the shared view

Example Response

{
  "uuid": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
  "url": "https://app.nocodb.com/shared/a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11"
}

List Shared Views

Retrieve all shared views for a table.

curl -X GET "https://app.nocodb.com/api/v1/db/meta/tables/{tableId}/share" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

tableId · string · required

Unique identifier for the table

Response

list · array

Array of shared view objects

list[].uuid · string

Unique identifier for the shared view

list[].url · string

Public URL for the shared view

list[].fk_view_id · string

Foreign key to the view being shared

Update Shared View

Update settings for a shared view.

curl -X PATCH "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/share" \
  -H "xc-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "secure123",
    "meta": {
      "allowCSVDownload": false
    }
  }'

Path Parameters

viewId · string · required

Unique identifier for the view

Request Body

password · string

Password to protect the shared view

meta · object

Additional settings for the shared view

custom_url_path · string

Custom URL path for the shared view

Delete Shared View

Remove public access to a shared view.

curl -X DELETE "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/share" \
  -H "xc-token: YOUR_API_TOKEN"

Path Parameters

viewId · string · required

Unique identifier for the view

Response

success · boolean

Returns true if the shared view was successfully deleted

Deleting a shared view only removes public access. The view itself and its data remain intact.

Row Coloring

Get Row Color Info

Retrieve row coloring configuration for a view.

curl -X GET "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/row-color" \
  -H "xc-token: YOUR_API_TOKEN"

Response

mode · string

Row coloring mode: select or filter

fk_model_id · string

Foreign key to the table

fk_view_id · string

Foreign key to the view

Set Row Color from Select Column

Configure row coloring based on a select column.

curl -X POST "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/row-color-select" \
  -H "xc-token: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "fk_column_id": "cl_abc123",
    "is_set_as_background": true
  }'

fk_column_id · string · required

Column ID to use for row coloring (must be a select column)

is_set_as_background · boolean · required

Whether to use the color as background or text color

Delete Row Color Info

Remove row coloring from a view.

curl -X DELETE "https://app.nocodb.com/api/v1/db/meta/views/{viewId}/row-color" \
  -H "xc-token: YOUR_API_TOKEN"

Lock Types

Views support three lock types:

Collaborative

{"lock_type": "collaborative"}

All users with access can modify the view configuration.

Locked

{"lock_type": "locked"}

Only the view owner and administrators can modify the view.

Personal

{"lock_type": "personal"}

Each user gets their own private copy of the view configuration.