Skip to main content
The 21 field types you can create through the REST API — their type string, value shape, and key settings (defaults in parentheses).
Computed and system types — rich_text, rollup, created_at, updated_at, updated_by, user — exist inside Zite apps but are platform-managed and can’t be created or configured through this API.
Notes
  1. numberFormat: local (default) · comma_period · period_comma · space_comma · space_period.
  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 — omit when creating, use in writes to reference existing options (reorder, or keep old + add new). 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 accepts a table ID or name during base creation; 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. Cannot be created during initial base setup — add later via the field-creation endpoint.
  9. { type: "public_api", apiKeyId? } | { type: "form_submission", flowPublicId, sessionId } | { type: "workflow", workflowId, executionId } | { type: "manual", reason?, userId? } | null.

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 — numberDisplayType: "number" (plain) · "currency" (use with decimalPlaces, numberFormat) · "percent" · "duration".
  • Dates — 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, 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.