Fields

List fields of a group

get/field-group/{groupId}/input

Request

  • Base URL: https://test.boost.space/api
  • URL: https://test.boost.space/api/field-group/{groupId}/input
  • Auth: HTTP bearer

Path parameters

groupIdinteger required

ID of field group

Query parameters

filterstring

Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5.

offsetinteger

Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30.

limitinteger

Maximum number of records to return. Use together with offset for pagination.

orderstring

Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC.

Response

Response 200

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

createdUserIdinteger

ID of user who created this record

namestring

Name of the Input.

descriptionstring

Description of input

tooltipstring

Content of tooltip.

percentUpTo100boolean

If true percent can be only 0 to 100.

isLabelstring

If true input is used as a label

classNamestring

Name of CSS class.

relatedEntityCfIdstring

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.

relatedValueCounterpartboolean

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

propertystring

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

inputType'related_entity' | 'related_entities' | 'related_value' | 'image' | 'money' | 'rating' | 'percent' | 'text' | 'number' | 'float' | 'select' | 'multiselect' | 'datetime' | 'file' | 'wysiwyg' | 'checkbox' | 'checkbox_group' | 'radio' | 'hidden' | 'firstname' | 'lastname' | 'email' | 'phone' | 'address' | 'gdpr_accept' | 'cookies_accept' | 'newsletter_accept' | 'address_city' | 'address_post_code' | 'address_country' | 'calculation' | 'rollup' | 'date' | 'url' | 'ai' | 'button' | 'users'

Type of input

requiredboolean

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

order=0integer

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

fieldGroupsinteger[]

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

actionIdinteger

The action to fire after the button click.

currencyIdinteger

ID of the currency used for the money input type.

spacesinteger[]

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

inputCalculationstring

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

relatedCustomModuleIdinteger

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

relatedEntityPropertystring

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

provider'platform' | 'websearch' | 'custom'

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

providerIdinteger

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

visibleboolean

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

rollupRelationInputIdinteger

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

rollupTargetInputIdinteger

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

rollupAggregation'showOriginal' | 'showUnique' | 'countAll' | 'countValues' | 'countUniqueValues' | 'countEmpty' | 'countNotEmpty' | 'percentEmpty' | 'percentNotEmpty' | 'sum' | 'average' | 'median' | 'min' | 'max' | 'range' | 'earliestDate' | 'latestDate' | 'dateRange' | 'checked' | 'unchecked' | 'percentChecked' | 'percentUnchecked'

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

aiPromptstring

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

aiVoiceTone'auto' | 'professional' | 'casual' | 'straightforward' | 'confident' | 'friendly' | 'humorous' | 'inspirational'

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

aiLength'auto' | 'word_or_two' | 'sentence' | 'few_sentences' | 'paragraph' | 'three_paragraphs'

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

aiFormatting'text' | 'formatted_text' | 'bullets' | 'numbered_list'

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

aiCreativity'high' | 'medium' | 'low'

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

aiType'auto' | 'manual'

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

translatableboolean

Is field translatable

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "createdUserId": 42,
    "name": "Sample name",
    "description": "string",
    "tooltip": "string",
    "percentUpTo100": true,
    "isLabel": "string",
    "className": "Sample className",
    "relatedEntityCfId": "string",
    "relatedValueCounterpart": true,
    "property": "string",
    "inputType": "related_entity",
    "required": true,
    "order=0": 1,
    "fieldGroups": [
      1
    ],
    "actionId": 42,
    "currencyId": 42,
    "inputOptions": [
      {
        "id": 42,
        "created": "2026-01-15T09:30:00Z",
        "createdUserId": 42,
        "customFieldInputId": 42,
        "label": "string",
        "value": "string",
        "color": "#1f6feb"
      }
    ],
    "remotes": [
      {
        "id": "1",
        "application": "string",
        "delete": true
      }
    ],
    "spaces": [
      1
    ],
    "inputCalculation": "string",
    "relatedCustomModuleId": 42,
    "relatedEntityProperty": "string",
    "provider": "platform",
    "providerId": 42,
    "visible": true,
    "rollupRelationInputId": 42,
    "rollupTargetInputId": 42,
    "rollupAggregation": "showOriginal",
    "aiPrompt": "string",
    "aiVoiceTone": "auto",
    "aiLength": "auto",
    "aiFormatting": "text",
    "aiCreativity": "high",
    "aiType": "auto",
    "translatable": true
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.