Skip to main content
The 28 field types you can create through the REST API: their type string, value shape, and key settings (defaults in parentheses). Every key setting is optional, except where marked required. Notes
  1. numberFormat: local (default) · comma_period · period_comma · space_comma · space_period · no_separator.
  2. Duration format: h:mm (default) · h:mm:ss · h:mm:ss.s · h:mm:ss.ss · h:mm:ss.sss.
  3. options[]: label required; color optional (auto-assigned if omitted); value optional, so omit it when creating. On update, options merge into the existing ones; see Update Field. Colors: purple, orange, blue, gray, red, yellow, green, pink, lime, tangerine, emerald, sky, teal, indigo, cyan, violet, fuchsia.
  4. dateFormat: local (default) · long · us · european · iso.
  5. timeFormat: 12h (default) · 24h.
  6. tableId takes a table ID. When you create a database or a table, it also accepts the name of a table in that database; Create Field takes IDs only. Creating the field auto-connects both tables in both directions.
  7. Single value if the linked-record field has allowMultiple: false, array if true; element type matches the looked-up field.
  8. Lookups and rollups can’t be created while creating a database or table. Add them afterwards with Create Field. linkedRecordFieldId and lookupFieldId/rollupFieldId take field IDs.
  9. { type: "public_api", apiKeyId? } | { type: "form_submission", flowPublicId, sessionId } | { type: "workflow", workflowId, executionId } | { type: "manual", reason?, userId? } | null.
  10. With allowMultiple: false the value is still an array, capped at one ID. internalOnly only limits the picker in the app UI to organization members. deleteRowWhenUserDeleted deletes the record when its user is removed, and only applies when allowMultiple is off.

Formula fields

Formula fields compute their value from other fields using a formula expression. They are read-only and automatically recalculate when referenced fields change. See the Formulas guide for the complete list of supported functions.
Formatting options
  • Numbers use numberDisplayType: "number" (plain) · "currency" (use with decimalPlaces, numberFormat) · "percent" · "duration".
  • Dates use dateFormat, timeFormat ("12h" or "24h"), timezone, displayTimeZone (whether to show the timezone).

Primary field

The first field in each table is the primary field and must be one of: single_line_text, long_text, date, datetime, phone_number, email, url, number, currency, percent, duration, autonumber, formula.

Empty values

Changing a field’s type after data exists can cause data loss if the new type is incompatible with existing values.