| name |
string |
optional |
Machine name (snake_case) |
| label |
string |
optional |
Human readable label |
| type |
Enum<'text' | 'textarea' | 'email' | 'url' | 'phone' | 'password' | 'markdown' | 'html' | 'richtext' | 'number' | 'currency' | 'percent' | 'date' | 'datetime' | 'time' | 'boolean' | 'select' | 'lookup' | 'master_detail' | 'image' | 'file' | 'avatar' | 'formula' | 'summary' | 'autonumber' | 'location' | 'geolocation' | 'address' | 'code' | 'color' | 'rating' | 'slider' | 'signature' | 'qrcode'> |
✅ |
Field Data Type |
| description |
string |
optional |
Tooltip/Help text |
| format |
string |
optional |
Format string (e.g. email, phone) |
| required |
boolean |
optional |
Is required |
| searchable |
boolean |
optional |
Is searchable |
| multiple |
boolean |
optional |
Allow multiple values (Stores as Array/JSON). Applicable for select, lookup, file, image. |
| unique |
boolean |
optional |
Is unique constraint |
| defaultValue |
any |
optional |
Default value |
| maxLength |
number |
optional |
Max character length |
| minLength |
number |
optional |
Min character length |
| precision |
number |
optional |
Total digits |
| scale |
number |
optional |
Decimal places |
| min |
number |
optional |
Minimum value |
| max |
number |
optional |
Maximum value |
| options |
object[] |
optional |
Static options for select/multiselect |
| reference |
string |
optional |
Target Object Name |
| referenceFilters |
string[] |
optional |
Filters applied to lookup dialogs (e.g. "active = true") |
| writeRequiresMasterRead |
boolean |
optional |
If true, user needs read access to master record to edit this field |
| deleteBehavior |
Enum<'set_null' | 'cascade' | 'restrict'> |
optional |
What happens if referenced record is deleted |
| expression |
string |
optional |
Formula expression |
| formula |
string |
optional |
Deprecated: Use expression |
| summaryOperations |
object |
optional |
Roll-up summary definition |
| language |
string |
optional |
Programming language for syntax highlighting (e.g., javascript, python, sql) |
| theme |
string |
optional |
Code editor theme (e.g., dark, light, monokai) |
| lineNumbers |
boolean |
optional |
Show line numbers in code editor |
| maxRating |
number |
optional |
Maximum rating value (default: 5) |
| allowHalf |
boolean |
optional |
Allow half-star ratings |
| displayMap |
boolean |
optional |
Display map widget for location field |
| allowGeocoding |
boolean |
optional |
Allow address-to-coordinate conversion |
| addressFormat |
Enum<'us' | 'uk' | 'international'> |
optional |
Address format template |
| colorFormat |
Enum<'hex' | 'rgb' | 'rgba' | 'hsl'> |
optional |
Color value format |
| allowAlpha |
boolean |
optional |
Allow transparency/alpha channel |
| presetColors |
string[] |
optional |
Preset color options |
| step |
number |
optional |
Step increment for slider (default: 1) |
| showValue |
boolean |
optional |
Display current value on slider |
| marks |
Record<string, string> |
optional |
Custom marks/labels at specific values (e.g., {0: "Low", 50: "Medium", 100: "High"}) |
| barcodeFormat |
Enum<'qr' | 'ean13' | 'ean8' | 'code128' | 'code39' | 'upca' | 'upce'> |
optional |
Barcode format type |
| qrErrorCorrection |
Enum<'L' | 'M' | 'Q' | 'H'> |
optional |
QR code error correction level (L=7%, M=15%, Q=25%, H=30%). Only applicable when barcodeFormat is "qr" |
| displayValue |
boolean |
optional |
Display human-readable value below barcode/QR code |
| allowScanning |
boolean |
optional |
Enable camera scanning for barcode/QR code input |
| hidden |
boolean |
optional |
Hidden from default UI |
| readonly |
boolean |
optional |
Read-only in UI |
| encryption |
boolean |
optional |
Encrypt at rest |
| index |
boolean |
optional |
Create standard database index |
| externalId |
boolean |
optional |
Is external ID for upsert operations |