GET
/
table
/
{tableId}
/
view
curl --request GET \
  --url https://app.teable.io/api/table/%7BtableId%7D/view \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
[
  {
    "id": "<string>",
    "name": "<string>",
    "type": "grid",
    "description": "<string>",
    "order": 123,
    "options": {
      "rowHeight": "short",
      "frozenColumnCount": 1
    },
    "sort": {
      "sortObjs": [
        {
          "fieldId": "<string>",
          "order": "asc"
        }
      ],
      "manualSort": true
    },
    "filter": {},
    "group": [
      {
        "fieldId": "<string>",
        "order": "asc"
      }
    ],
    "isLocked": true,
    "shareId": "<string>",
    "enableShare": true,
    "shareMeta": {
      "allowCopy": true,
      "includeHiddenField": true,
      "password": "<string>",
      "includeRecords": true,
      "submit": {
        "allow": true,
        "requireLogin": true
      }
    },
    "createdBy": "<string>",
    "lastModifiedBy": "<string>",
    "createdTime": "<string>",
    "lastModifiedTime": "<string>",
    "columnMeta": {},
    "pluginId": "<string>"
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
tableId
string
required

Response

200 - application/json
Returns the list of view.
​
id
string
required
​
name
string
required
​
type
enum<string>
required
Available options:
grid,
calendar,
kanban,
form,
gallery,
gantt,
plugin
​
createdBy
string
required
​
createdTime
string
required
​
columnMeta
object
required

A mapping of view IDs to their corresponding column metadata.

​
description
string
​
order
number
​
options
object
​
sort
object | null
​
filter
object

A filter object used to filter results. It allows complex query conditions based on fields, operators, and values.

​
group
object[] | null
​
isLocked
boolean
​
shareId
string
​
enableShare
boolean
​
shareMeta
object
​
lastModifiedBy
string
​
lastModifiedTime
string
​
pluginId
string
Previous
Post table view
Next