Entity Custom Fields

Entity Custom Fields

Overview

Each entity type has its own set of custom fields that define its data structure. Fields work the same way as contact custom fields but are scoped to a specific entity type.

Adding Fields

Open an entity type and click Add Field. Configure:

• Name — display label, required, max 255 characters
• Key — unique identifier, required, lowercase letters/numbers/underscores only (e.g., project_status). Used in filters, imports, and API access.
• Type — one of 11 field types (see below)
• Required — when enabled, this field must be filled in when creating or editing a record
• Primary — marks this field as the display name for the record. Only one field per entity type can be primary. Used in listing pages, relationship selectors, and anywhere the record needs a display name. If no primary field is set, records show as "Record #123".

Field Types

• Text — single-line text input
• Text Area — multi-line text for longer content
• Number — numeric value stored with up to 4 decimal places. Validated as numeric on save.
• Date — date picker. Stored as a proper date value with a separate indexed column for efficient date-range queries.
• Yes/No — boolean toggle. Stored with a separate boolean column for efficient filtering.
• Dropdown — single-select from a predefined list of options. Each option is a text string (max 255 characters). Can optionally allow multiple selections.
• Radio — radio button group for single selection. Same as Dropdown but displayed as radio buttons.
• Checkbox — multi-select from a predefined list. Stored as a JSON array of selected values.
• URL — web address with URL format validation
• Email — email address with email format validation
• Relationship — links to contacts or other entity records (see the Relationships article)

Value Storage

Custom field values are stored in a dedicated table with typed columns for efficient querying:

• Text, Textarea, URL, Email — stored as text strings
• Number — stored in both a text column and a decimal column (15 digits, 4 decimal places) for numeric sorting and filtering
• Date — stored in both a text column and a date column for date-range queries
• Yes/No — stored in both a text column and a boolean column
• Dropdown/Radio — stored as a text string (the selected option value)
• Checkbox/Multi-select — stored as a JSON array of selected values
• Relationship — stored as a reference string or JSON array of reference strings

Reordering Fields

Drag and drop fields to reorder them. The position determines the order fields appear in forms, detail pages, and listing columns.

Editing & Deleting Fields

You can rename a field or change its options at any time. Changing the field type is not supported after creation (you would need to delete and recreate the field). Deleting a field permanently removes all stored values for that field across all records of the entity type.