Field Groups

List field groups

get/field-group

Request

Base URL: https://test.boost.space/api
URL: https://test.boost.space/api/field-group
Auth: HTTP bearer

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

List of Field Group records

idinteger

Unique identifier - primary key

createdstring date-time

Creation timestamp

namestring

Name of the Field Group.

modulestring

Module name this field group belongs to (e.g. 'contact', 'deal').

tablestring

Specific table within the module this field group targets; used when a module has multiple tables.

sizestring

Layout width of the field group in the UI (e.g. 'full', 'half').

weightinteger

Ordering index controlling the display sequence of field groups; lower values appear first.

inputSizestring

Default layout width applied to each field inside this group (e.g. 'full', 'half').

staticstring

Static HTML/text content rendered inside the group; used for informational or decorative groups with no input fields.

systemNamestring

Group system name - if set (non-changeable) - only for protected field groups

derivedFrominteger

ID of group from which this group has been derived - only for protected field groups

boostIdstring

Boost space internal record identification

protectedboolean

Marks field group as system default - non-changeable

autoAttachboolean

When true, this field group is automatically attached to new records in the target module.

Example response

[
  {
    "id": 42,
    "created": "2026-01-15T09:30:00Z",
    "name": "Sample name",
    "module": "string",
    "table": "string",
    "size": "string",
    "weight": 1,
    "inputSize": "string",
    "static": "string",
    "systemName": "Sample systemName",
    "derivedFrom": 1,
    "boostId": "string",
    "protected": true,
    "inputs": [
      {
        "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": [],
        "actionId": 42,
        "currencyId": 42,
        "inputOptions": [],
        "remotes": [],
        "spaces": [],
        "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
      }
    ],
    "entities": [
      {
        "entityId": 42,
        "module": "string",
        "spaceId": 42,
        "fieldGroupPositionId": 42,
        "position": "string"
      }
    ],
    "autoAttach": true
  }
]

Changes

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