EntityFieldOutput

  • createdAt
    Type: stringFormat: date-time
    required

    Creation timestamp

  • fieldKey
    Type: string
    required

    Field key for internal reference

  • fieldType
    Type: stringnullable
    required

    Type of field

  • id
    Type: string
    required

    Unique field identifier

  • order
    Type: integer
    required

    Display order of the field

  • config
    Type: Confignullable

    Field configuration

    Properties: 1
  • dataSource
    Type: DataSourceenumnullable

    Source of field data (optional for creation)

    values
    • system
    • manual
    • hybrid
    • company
    • person
    • lead
    • deal
    • contract
  • displayType
    Type: stringnullable

    Type of field display (optional for creation)

  • dreamerFlow
    Type: Dreamerflownullable

    Dreamer flow configuration

    Properties: 1
  • fieldManagement
    Type: FieldManagementCapabilitiesnullable

    Field-definition management capabilities for clients

    Properties: 5
  • filledByDreamer
    Type: booleannullable

    Whether field is filled by dreamer

  • helpText
    Type: stringnullable

    Help text for the field

  • isDeleted
    Type: booleannullable

    Soft delete flag

  • label
    Type: stringnullable

    Display label for the field

  • linkedDataInfo
    nullable

    Linked data information (LinkedDataInfo for LINKED fields, SCODataInfo for SCO fields)

    Structured validation for linked data information

    • sourceKey
      Type: stringnullable
      required

      Source key field

    • targetKey
      Type: stringnullable
      required

      Target key field

    • targetTable
      Type: stringnullable
      required

      Target table name

    • targetType
      Type: stringnullable
      required

      Target field type

    • targetField
      Type: stringnullable

      Target field key; set from target_field_id on create

  • readOnly
    Type: boolean

    Whether entity values for this field are read-only

  • required
    Type: boolean

    Whether the field is required

  • section
    Type: integernullable

    Section ID (used for additional fields)

  • showInCreation
    Type: boolean

    Whether to show in creation forms

  • showInDetailedView
    Type: boolean

    Whether the field should be displayed in the entity's detailed view

  • propertyName
    additionalPropertyType: anything