Airtable · Schema

FieldSchema

The schema definition of a field within a table.

ApplicationsCollaborationDataDatabasesLow-CodeProductivitySpreadsheets

Properties

Name Type Description
id string The unique identifier of the field (starts with 'fld').
name string The name of the field.
type string The type of the field.
description string The description of the field.
options object Configuration options for the field. The structure depends on the field type.
View JSON Schema on GitHub

JSON Schema

airtable-fieldschema-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/FieldSchema",
  "title": "FieldSchema",
  "type": "object",
  "description": "The schema definition of a field within a table.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the field (starts with 'fld').",
      "example": "fldABC123def456"
    },
    "name": {
      "type": "string",
      "description": "The name of the field."
    },
    "type": {
      "type": "string",
      "description": "The type of the field.",
      "enum": [
        "singleLineText",
        "email",
        "url",
        "multilineText",
        "number",
        "percent",
        "currency",
        "singleSelect",
        "multipleSelects",
        "singleCollaborator",
        "multipleCollaborators",
        "multipleRecordLinks",
        "date",
        "dateTime",
        "phoneNumber",
        "multipleAttachments",
        "checkbox",
        "formula",
        "createdTime",
        "rollup",
        "count",
        "lookup",
        "multipleLookupValues",
        "autoNumber",
        "barcode",
        "rating",
        "richText",
        "duration",
        "lastModifiedTime",
        "button",
        "createdBy",
        "lastModifiedBy",
        "externalSyncSource",
        "aiText"
      ]
    },
    "description": {
      "type": "string",
      "description": "The description of the field."
    },
    "options": {
      "type": "object",
      "description": "Configuration options for the field. The structure depends on the field type.",
      "additionalProperties": true
    }
  },
  "required": [
    "id",
    "name",
    "type"
  ]
}