Web API

Press shift + S to search API reference.

Fields

Create field

posthttps://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableId}/fields

Creates a new column and returns the schema for the newly created column.

Refer to field types for supported field types, the write format for field options, and other specifics for certain field types. Supported field types have a write format shown.

Requirements

AuthenticationPersonal access token, OAuth integration
Scopeschema.bases:write
User role

Base creator

Billing plansAll plans

Path parameters

baseId
string
tableId
string

Request body

Field model with name

This identical to Field type and options, with an additional name and description property on all types

Response format

id
string
type
optional<Field Type>
name
string
description
optional<string>
options
optional<Field options>
Request (example)
Copy
$
curl -X POST "https://api.airtable.com/v0/meta/bases/{baseId}/tables/{tableId}/fields" \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"description": "Whether I have visited this apartment yet.",
"name": "Visited",
"options": {
"color": "greenBright",
"icon": "check"
},
"type": "checkbox"
}'
200 – Response (example)
{
"description": "Whether I have visited this apartment yet.",
"id": "fldumZe00w09RYTW6",
"name": "Visited",
"options": {
"color": "redBright",
"icon": "star"
},
"type": "checkbox"
}