Array of multiple Field objects
- Type: array object[] · Array of multiple Field objects
- actionType: integer
Id The action to fire after the button click.
- aiType: string enum
Creativity Controls the expressiveness of the language in the content. Only works if type=ai
values- high
- medium
- low
- aiType: string enum
Formatting Refers to the structural and visual organization of the content. Only works if type=ai
values- text
- formatted
_text - bullets
- numbered
_list
- aiType: string enum
Length Specifies the desired extent of the content. Only works if type=ai
values- auto
- word
_or _two - sentence
- few
_sentences - paragraph
- three
_paragraphs
- aiType: string
Prompt The Prompt field is a text parameter used to define the specific input for generating responses or actions in OpenAI's models. Only works if type=ai
- aiType: string enum
Type Specifies whether the AI field should be controlled automatically or manually.
values- auto
- manual
- aiType: string enum
Voice Tone Determines the style and attitude of AI response. Only works if type=ai
values- auto
- professional
- casual
- straightforward
- confident
- friendly
- humorous
- inspirational
- classType: string
Name Name of CSS class.
- createdType: string Format: date-timeread-only
Creation timestamp
- createdType: integer
User Id read-onlyID of user who created this record
- currencyType: integer
Id ID of the currency used for the money input type.
- descriptionType: string
Description of input
- fieldType: array integer[]
Groups IDs of the FieldGroup's this field belongs to, controlling where it is rendered.
- idType: integerread-only
Unique identifier - primary key
- inputType: string
Calculation Formula used to compute the field value. The value is evaluated at read time and is not stored; the resulting FieldValue is read-only. Syntax: reference other fields of the same record with FIELD("Field Name"), where the argument is the field's name (customFieldInputName) for custom fields, or the property name of a core column (e.g. FIELD("id"), FIELD("created")). String literals are written in double quotes ("text"), numbers as plain literals (42, 3.14), booleans as true/false. Operators: arithmetic + - * / % ^, comparison == != > < >= <=, logical && || !, parentheses for grouping. Functions are called as name(arg1, arg2, ...) and their names are case-insensitive. Available functions — arithmetic: sum, subtract, multiply, divide, mod, power, sqrt, abs, round, roundUp, roundDown, ceil, floor, average, max, min, count, countAll; logic: if, switch, and, or, not, xor, equals, greaterThan, lessThan, isEmpty, isNotEmpty, isError; text: concat, length, lower, upper, trim, contains, startsWith, endsWith, replace, substring, left, right, split, indexOf, regexMatch, regexExtract, regexReplace, format; date: now, today, dateAdd, dateSubtract, dateDiff, formatDate, year, month, day, weekday, isAfter, isBefore, workdays; array: arrayJoin, arrayUnique, arrayLength; conversion: toNumber, toString, toBoolean, toDate; record: field, recordId, createdAt, updatedAt, createdByUserId, createdByUserName. Example: if(FIELD("Deal Value") > 1000, concat("VIP: ", FIELD("Company")), "Standard"). Use POST /validate-calculation-function to check a formula before saving. Only works if type=calculation
- inputType: array object[] · FieldOption[]
Options In case of select or multiselect, set of options
- inputType: string enum
Type Type of input
values- related
_entity - related
_entities - related
_value - image
- money
- isType: string
Label If true input is used as a label
- nameType: string
Name of the Input.
- order=0Type: integer
Display order of this field within its field group; lower values appear first.
- percentType: boolean
Up To100 If true percent can be only 0 to 100.
- propertyType: string
It is used for the field type related_value. It describes which entity property should be load.
- providerType: string enum
AI provider used to generate the field value. Only works if type=ai
values- platform
- websearch
- custom
- providerType: integer
Id ID of the provider configuration; used when provider=custom. Only works if type=ai
- relatedType: integer
Custom Module Id ID of the custom module a related_entity/related_entities field links to. When null, the field's
modulecolumn identifies the linked module. - relatedType: string
Entity Cf Id This is the link for the field type related_value, linking to a related_entity field. The related_value field uses this link to load a module and entity ID.
- relatedType: string
Entity Property Name of the related entity's property to load, used when the source is an entity property rather than a custom field.
- relatedType: boolean
Value Counterpart This is an option for the field type related_entity that enables rendering the counterpart in the entity this field links to.
- remotesType: array object[] · Remote id[]
IDs of remote integrations linked to this field.
- requiredType: boolean
Whether filling out this field is required when submitting the form (true = required, false = optional).
- rollupType: string enum
Aggregation Aggregation function applied to the target field values of the linked records; the rollup's return type is derived from this aggregation and the target field's data type. Required for the rollup to compute. Only works if type=rollup
values- show
Original - show
Unique - count
All - count
Values - count
Unique Values
- rollupType: integer
Relation Input Id ID of the relation field the rollup follows to reach the linked records; must be a field of inputType related_entity or related_entities. Required for the rollup to compute. Only works if type=rollup
- rollupType: integer
Target Input Id ID of the custom field on the linked records whose values get aggregated; must not be a rollup or calculation field. Required for the rollup to compute. Only works if type=rollup
- spacesType: array integer[]
IDs of spaces this field's related_entity/related_value lookup is restricted to; empty means no restriction.
- tooltipType: string
Content of tooltip.
- translatableType: boolean
Is field translatable
- visibleType: boolean
Whether the field is visible (true = visible, false = hidden).