Skip to main content

​
Overview

Configuration fields define the custom data fields that appear on entity forms (events, insureds, and policies). Each field has a definition specifying its type, key, display label, and optional configuration like select options or calculations. These endpoints manage entity fields only. Rating fields, rating outputs, and rating presets are managed through separate /configuration/rating/ endpoints.

​
Key Concepts

  • fieldDefinition: A JSON object defining the field’s type (className), unique key, data path, and optional properties like label, section, and select options
  • entityName: The entity type the field is associated with — events, insureds, or policies
  • className: The field type — InputField, SelectField, DateField, RadioSelect, or ExportResolvedField

​
API Endpoints

MethodEndpointDescription
GET/configuration/fieldsList all entity fields with filtering and pagination
POST/configuration/fieldsCreate a new entity field
DELETE/configuration/fields/{fieldId}Delete an entity field

​
Permissions

ActionPermission
List fieldscompany:read
Create fieldcompany:update
Delete fieldcompany:update

​
Field Definition Properties

PropertyTypeRequiredDescription
classNamestringYesField type: InputField, SelectField, DateField, RadioSelect, ExportResolvedField
keystringYesUnique field key (cannot be companyId)
pathstringYesDot-notation path for the field value in entity data
labelstringNoHuman-readable label
sectionstringNoUI section grouping
requiredbooleanNoWhether the field is required
fieldsobjectNoSub-field configuration (e.g., select options)
calculationobjectNoCalculation configuration for computed fields

​
Example Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440100",
      "entityName": "policies",
      "fieldDefinition": {
        "className": "InputField",
        "key": "policyState",
        "path": "policyState",
        "label": "Policy State",
        "section": "Policy Information",
        "required": true
      },
      "createdAt": "2025-01-15T10:30:00.000Z",
      "updatedAt": "2025-01-20T14:00:00.000Z"
    }
  ],
  "totalCount": 1
}