FieldGroup

Positional slot ID that determines where the group appears within the entity layout.

Module name identifying the type of entity this field group is attached to (e.g. 'contact', 'custom-module-item').

Related entity id

Field group position in this entity. Common values: tab, form, form-top, top-todolist, case-top, case-bottom, contract-top, contract-bottom; a value outside these falls back to the module default position (e.g. 'bottom', or 'tab' for stock items). Not an enum — any string may be returned.

ID of the space this field group attachment is scoped to.

The action to fire after the button click.

Controls the expressiveness of the language in the content. Only works if type=ai

Refers to the structural and visual organization of the content. Only works if type=ai

Specifies the desired extent of the content. Only works if type=ai

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

Specifies whether the AI field should be controlled automatically or manually.

Determines the style and attitude of AI response. Only works if type=ai

Name of CSS class.

Creation timestamp

ID of user who created this record

ID of the currency used for the money input type.

Description of input

IDs of the FieldGroup's this field belongs to, controlling where it is rendered.

Unique identifier - primary key

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

In case of select or multiselect, set of options

Type of input

If true input is used as a label

Name of the Input.

Display order of this field within its field group; lower values appear first.

If true percent can be only 0 to 100.

It is used for the field type related_value. It describes which entity property should be load.

AI provider used to generate the field value. Only works if type=ai

ID of the provider configuration; used when provider=custom. Only works if type=ai

ID of the custom module a related_entity/related_entities field links to. When null, the field's module column identifies the linked module.

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.

Name of the related entity's property to load, used when the source is an entity property rather than a custom field.

This is an option for the field type related_entity that enables rendering the counterpart in the entity this field links to.

IDs of remote integrations linked to this field.

Whether filling out this field is required when submitting the form (true = required, false = optional).

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

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

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

IDs of spaces this field's related_entity/related_value lookup is restricted to; empty means no restriction.

Content of tooltip.

Is field translatable

Whether the field is visible (true = visible, false = hidden).