Skip to main content

JSON

JSON fields store flexible, structured data as JSON objects.

View all settings
SettingDescription
Field NameText input, required. Unique identifier for the field.
Input TypeDropdown, required. Choose Json or Jsonb.
Display LabelText input. Human-readable label shown in forms.
Sort OrderNumber input, defaults to 0. Position in field lists.
IconIcon picker. Visual identifier.
Json ObjectDropdown. Select a JSON schema. Required for Jsonb, optional for Json.
StatusToggle, defaults to true. Enable or disable the field.
RequiredCheckbox. Make the field mandatory.
DescriptionText area. Documents the field's purpose.
Form VisibilityDropdown. Show in Add, Edit, or Both forms.
DB Field NameText input. Custom database column name.
Use as IndexCheckbox. Create database index for performance.

Input Types​

  • Json — Standard JSON storage, preserves exact input format. No schema validation required
  • Jsonb — Binary JSON format, optimized for queries and indexing. Requires a Json Object schema
tip

JSONB is recommended for most use cases as it supports indexing and faster queries. Use Json only when you need to preserve exact formatting or don't require schema validation.

When to Use​

Choose JSON when:

  • Data structure varies between records
  • You need flexible, schema-less storage
  • Storing API responses or external data
  • Nesting complex objects that don't need their own collections

Settings​

See Common Settings for shared options.

Not available: Primary Key, Unique, Faker Type, Populate from Logged-In User

Json Object (Basic Settings)​

Dropdown. Select a predefined JSON schema to validate the structure of your data.

  • Required when Input Type is Jsonb
  • Not required when Input Type is Json
note

JSON Object documentation coming soon.

Use Cases​

  • Metadata and configuration objects
  • Flexible attributes that vary per record
  • API response storage
  • User preferences and settings
  • Complex nested data structures