Creating Entity Types

Creating Entity Types

What Are Entity Types?

Entity types let you define entirely new data structures beyond the built-in Contacts. Examples: Companies, Projects, Products, Cases, Properties, Vehicles, Tickets — anything your business needs to track. Each entity type gets its own listing page, detail pages, custom fields, tags, and sidebar navigation entry.

Creating an Entity Type

Go to Customize > Entity Types and click New Entity Type. Configure the following:

• Name — required, the display name (e.g., "Company"). Maximum 255 characters.
• Slug — auto-generated from the name (e.g., "companies"). Must be unique, lowercase, and contain only letters, numbers, dashes, and underscores. Used in URLs and permission names.
• Singular name — auto-set to the name if not provided (e.g., "Company"). Used in UI labels like "New Company".
• Plural name — auto-generated as the plural form (e.g., "Companies"). Used in the sidebar and listing page header.
• Icon — optional, choose from 440+ Lucide icons. Displayed in the sidebar and listing pages.
• Color — optional, a color identifier for visual distinction.
• Description — optional, maximum 1,000 characters. Shown on the entity types management page.

Automatic Permission Creation

When you create an entity type, four permissions are automatically created:

• {slug}.view — view records of this type
• {slug}.create — create new records
• {slug}.edit — edit existing records
• {slug}.delete — delete records

These permissions are automatically granted to all "Full Access" roles in your agency. Other roles will need the permissions added manually through the Roles page.

Sidebar Navigation

Active entity types appear in the sidebar under Custom Entities. Each shows its icon (or a default database icon) and plural name. If you have any entity types, a "Manage Types" link also appears at the bottom of the section.

Activating & Deactivating

Entity types have an Active toggle. Deactivating an entity type hides it from the sidebar and prevents new records from being created, but preserves all existing data. Reactivating it restores everything.

Reordering

Drag and drop entity types on the management page to change their sidebar order. Position numbers are updated automatically.

Deleting an Entity Type

Deleting an entity type permanently removes all of its records, custom fields, custom field values, and the four associated permissions. Role assignments for those permissions are also cleaned up. This action cannot be undone.