Sign in

v1

latestOpenAPI 3.0.02026-07-2638801.8 MB
field

Get a field

Retrieve detailed information about a specific field by its ID

get/table/{tableId}/field/{fieldId}

Path parameters

tableIdstring required
fieldIdstring required

Response

Returns data about a field.

idstring required

The id of the field.

namestring required

The name of the field. can not be duplicated in the table.

type'singleLineText' | 'longText' | 'user' | 'attachment' | 'checkbox' | 'multipleSelect' | 'singleSelect' | 'date' | 'number' | 'rating' | 'formula' | 'rollup' | 'conditionalRollup' | 'link' | 'createdTime' | 'lastModifiedTime' | 'createdBy' | 'lastModifiedBy' | 'autoNumber' | 'button' required

The field types supported by teable.

descriptionstring

The description of the field.

isLookupboolean

Whether this field is lookup field. witch means cellValue and [fieldType] is looked up from the linked table.

isConditionalLookupboolean

Whether this lookup field applies a conditional filter when resolving linked records.

notNullboolean

Whether this field is not null.

uniqueboolean

Whether this field is not unique.

isPrimaryboolean

Whether this field is primary field.

isComputedboolean

Whether this field is computed field, you can not modify cellValue in computed field.

isPendingboolean

Whether this field's calculation is pending.

hasErrorboolean

Whether This field has a configuration error. Check the fields referenced by this field's formula or configuration.

cellValueType'string' | 'number' | 'boolean' | 'dateTime' required

The cell value type of the field.

isMultipleCellValueboolean

Whether this field has multiple cell value.

dbFieldType'TEXT' | 'INTEGER' | 'DATETIME' | 'REAL' | 'BLOB' | 'JSON' | 'BOOLEAN' required

The field type of database that cellValue really store.

dbFieldNamestring required

Field(column) name in backend database. Limitation: 1-63 characters, can only contain letters, numbers and underscore, case sensitive, cannot be duplicated with existing db field name in the table.

recordReadboolean

Field record read permission. When set to false, reading records is denied. When true or not set, reading records is allowed.

recordCreateboolean

Field record create permission. When set to false, creating records is denied. When true or not set, creating records is allowed.

Example response

{
  "name": "Tags",
  "type": "singleSelect",
  "description": "this is a summary"
}