Short text

For a single line of text. Stored as a string.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

short_text

ui

enum

Interface type shown to admins in the dashboard. Defaults to the first enum value.

Possible enum values:

short_textemailurlslug

min

int

Minimum character count allowed for the field value.

max

int

Minimum character count allowed for the field value

format

enum

Formatting rule applied to the field value.

Possible enum values:

currency-codeemailslugslugidurlsemverdomain

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

string

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

The short text field model

{
  "id": "item_type",
  "label": "Item type",
  "type": "short_text",
  "localized": true,
  "public": true
}

Long text

For multiple lines of text that can have formatting. Stored as a string.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

long_text

ui

enum

Interface type shown to admins in the dashboard. Defaults to the first enum value.

Possible enum values:

long_textbasic_htmlrich_htmlmarkdownblocks

min

int

Minimum character count allowed for the field value.

max

int

Minimum character count allowed for the field value

html_tags

enum

Allowed HTML tags (If null, default tags for the UI type are allowed).

Possible enum values:

[string]

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

string

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

The long text field model

{
  "id": "profile_bio",
  "label": "Profile bio",
  "type": "long_text",
  "ui": "basic_html",
  "max": 250,
  "localized": true,
  "public": true
}

Int

For values that need to be parsed as numbers. Stored as a float if `digits` are specified, otherwise as an integer.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

int

ui

enum

Interface type shown to admins in the dashboard. Defaults to the first enum value.

Possible enum values:

intfloatcurrencyslider

min

int

The lowest field value allowed.

max

int

The highest field value allowed.

increment

int

The interval between numbers, if the `ui` supports it.

digits

int

Explicit number of decimal digits for storing and displaying the field value.

unit

string

Unit of measurement for the field value. Displayed in the admin dashboard and used for conversion logic, if available.

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

int

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Bool

A true/false value. Stored as a boolean.

Arguments

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

bool

ui

enum

Interface type shown to admins in the dashboard. Defaults to the first enum value.

Possible enum values:

checkboxtoggle

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

int

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Select

For defining multiple options that can be chosen from. The stored value type depends on how `options` and `multi` are configured.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

select

ui

enum

Interface type shown to admins in the dashboard. Defaults to the first enum value.

Possible enum values:

dropdowncheckboxesradio

options

enum

Options that can be selected by users. All options must be the same data type; either string, number, or object.

Possible enum values:

stringnumber{ label, value }

multi

boolean

Whether multiple values can be selected at once.

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

enum

Default field value for new records. Must be one of the values specified for `options`.

Possible enum values:

stringnumberobject

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

For date and time input. Stored as an ISO 8601 date/time string. A variety of input formats are accepted for the value, including Unix time in milliseconds, a parseable timestamp string, or simply \\'now\\'.

Arguments

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

date

ui

enum

Interface type shown to admins in the dashboard. Defaults to the first enum value.

Possible enum values:

datetimedatetime

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

enum

Default field value for new records. Using 'now' is ideal in many cases.

Possible enum values:

stringnumber

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Asset

For binary files such as media and documents. Stored as an array of files if `multi` is `true`, otherwise as a single file.

Arguments

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

asset

asset_types

enum

Types of files allowed to be uploaded.

Possible enum values:

imagevideodocument

multi

boolean

Whether multiple files can be added.

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Lookup

For referencing a record of another model. Stored as a string.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

lookup

collection

stringrequired

Collection ID to lookup records of.

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

int

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Collection

A nested collection of records or references to records in another collection. Stored as an array. Can be infinitely nested, and supports either single or multiple item types.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

collection

fields

enum

Schema definition for nested record collection, if only a single type is needed.

Possible enum values:

[object]

item_types

enum

IDs of allowed content types (to reference) or inline schema definitions.

Possible enum values:

stringobject

item_label

string

Path of nested field or record used as the display label for each item.

required

boolean

Whether a field value is required to create or update the record.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Field group

For grouping several conceptually related fields together to make the editing UI more intuitive and less cluttered. Stored as an array of fields.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

type

enumrequired

Designates the field type.

Possible enum values:

field_group

fields

enum

Fields to display within the group.

Possible enum values:

object

Color

For representing color swatches as Hex, RGB, or HSL codes. Stored as a string.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field's purpose.

type

enumrequired

Designates the field type.

Possible enum values:

color

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

string

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

Icon

Choose from a list of icons. Stored as a string.

Fields

id

stringrequired

Key used to reference the field on a record, relative to the root path. Supports object notation for nesting values.

label

stringrequired

Display name shown to admins in the dashboard.

description

string

Informational text for admins and developers describing the field\'s purpose.

type

enumrequired

Designates the field type.

Possible enum values:

icon

required

boolean

Whether a field value is required to create or update the record.

unique

boolean

Whether the field value must be unique among records of the same collection.

default

string

Default field value for new records.

placeholder

string

Example field value or hint shown to admin users when the field is empty.

localized

boolean

Whether the field value can be set per locale.

root

enum

Base path on records. Use object notation for placing field on nested data structures

Possible enum values:

booleanstring

public

boolean

Whether the field is available in the Frontend API.

← Back: Gift card products Next: Events →