JSON
JSON fields store flexible, structured data as JSON objects.
Go to Studio → Collections → [Collection Name] → Fields tab → Add Field, then select JSON. To edit an existing field, click the edit action next to it.
View all settings
| Setting | Description |
|---|---|
| Field Name | Text input, required. Unique identifier for the field. |
| Input Type | Dropdown, required. Choose Json or Jsonb. |
| Display Label | Text input. Human-readable label shown in forms. |
| Icon | Icon picker. Visual identifier. |
| Json Object | Dropdown. Select a JSON Object schema. Required for Jsonb, optional for Json. |
| Status | Toggle, defaults to true. Enable or disable the field. |
| Required | Checkbox. Make the field mandatory. |
| Description | Text area. Documents the field's purpose. |
| Form Visibility | Dropdown. Show in Add, Edit, or Both forms. |
| DB Field Name | Text input. Custom database column name. |
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
Json Object (Basic Settings)
Dropdown. Select a predefined JSON Object schema to validate the structure of your data.
- Required when Input Type is Jsonb
- Not required when Input Type is Json
See the JSON Object documentation for details on how to create and manage these schemas.
Use Cases
- Metadata and configuration objects
- Flexible attributes that vary per record
- API response storage
- User preferences and settings
- Complex nested data structures
Related
- Common Settings — Shared settings reference