GET
/
table
/
{tableId}
/
field
curl --request GET \
  --url 'https://app.teable.cn/api/table/%7BtableId%7D/field?viewId=SOME_STRING_VALUE&filterHidden=SOME_BOOLEAN_VALUE&projection=SOME_ARRAY_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
[
  {
    "id": "<string>",
    "name": "Tags",
    "type": "singleSelect",
    "description": "this is a summary",
    "options": {
      "expression": "countall({values})",
      "timeZone": "<string>",
      "formatting": {
        "date": "<string>",
        "time": "HH:mm",
        "timeZone": "<string>"
      },
      "showAs": {
        "type": "url"
      }
    },
    "aiConfig": {
      "modelKey": "<string>",
      "isAutoFill": true,
      "attachPrompt": "<string>",
      "type": "extraction",
      "sourceFieldId": "<string>"
    },
    "isLookup": true,
    "lookupOptions": {
      "foreignTableId": "<string>",
      "lookupFieldId": "<string>",
      "relationship": "oneOne",
      "fkHostTableName": "<string>",
      "selfKeyName": "<string>",
      "foreignKeyName": "<string>",
      "filter": {},
      "linkFieldId": "<string>"
    },
    "notNull": true,
    "unique": true,
    "isPrimary": true,
    "isComputed": true,
    "isPending": true,
    "hasError": true,
    "cellValueType": "string",
    "isMultipleCellValue": true,
    "dbFieldType": "TEXT",
    "dbFieldName": "<string>",
    "recordRead": true,
    "recordCreate": true
  }
]

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
tableId
string
required

Query Parameters

​
viewId
string

The id of the view.

​
filterHidden
boolean | null
​
projection
string[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained

Response

200 - application/json

Returns the list of field.

The response is of type object[].