id
| string | |
label
| string | Label of the field |
data_type
| string | Type of the values of the field
| Type |
Description |
Checkbox |
A boolean value (true/false) |
Currency |
A monetary value |
Date |
A date value |
Dropdown |
A single selection from predefined options (see data.options) |
Email |
An email address |
List |
Multiple selections from predefined options (see data.options) |
Number |
A numeric value |
Phone |
A phone number |
Text |
A single-line text value |
TextArea |
A multi-line text value |
|
data
| object | Additional configuration for the field. Only used for Dropdown and List data types. |
|
Show object properties
| Property |
Type |
Description |
options
| array string | List of valid options for Dropdown and List field types.
For Dropdown, the user selects one option. For List, the user can select multiple options. |
labels
| object | Optional human-readable labels for each option. Keys are the option values, values are the display labels.
If not provided, the option values are used as labels. |
|
required
| boolean | Is this field required (true) or optional (false) |
scope
| string | Type of objects this field gets associated with |
