​
string (default)

A property that should be stored and read as a basic string.

​
config.appearance
object

Controls the visual presentation of the string field in the interface.

​
config.appearance.width
number

The width of the column in pixels.

{
  "key": "currency",
  "label": "Product Code",
  "type": "string",
  "config": {
    "appearance": {
      "width": 200
    }
  }
},

​
string-list

This feature requires Advanced Mapping.
For more information or to upgrade your plan, please reach out to Support.

A property that stores an array of strings. This is useful for fields that need to contain multiple text values.

{
  "key": "tags",
  "label": "Tags",
  "type": "string-list"
}

​
number

A property that should be stored and read as either an integer or floating point number. Database engines should look at the configuration to determine ideal storage format.

​
config.decimalPlaces
number

The number of decimal places to preserve accuracy to. Overages should be automatically rounded with a warning. A hook can pre-format to accomplish floor or ceiling. @deprecated Use data hooks for decimal place formatting instead.

  {
    "key": "price",
    "label": "Retail Price",
    "type": "number",
    "config": {
      "decimalPlaces": 2
    }
  },

​
reference

Defines a singular one-to-one reference to a field another sheet.

​
config.ref
required

The sheet slug of the referenced field. Must be in the same workbook.

​
config.key
string
default:"id"

The key of the property to use as the reference key.

 {
        "key": "author",
        "type": "reference",
        "label": "Authors",
        "config": {
          "ref": "authors",
          "key": "name"
        }
      },

​
reference-list

This feature requires Advanced Mapping.
For more information or to upgrade your plan, please reach out to Support.

Defines a reference list referencing a column in another sheet. Enables including multiple values from the given data field.

​
config.ref
required

The sheet slug of the referenced field. Must be in the same workbook.

​
config.key
string
default:"id"

The key of the property to use as the reference key.

 {
    "key": "author",
    "type": "reference-list",
    "label": "Authors",
    "config": {
      "ref": "authors",
      "key": "name"
    }
  },

​
enum

Defines an enumerated list of options for the user to select from. Matching tooling attempts to resolve incoming data assignment to a valid option. The maximum number of options for this list is 100. For larger lists, users should use the reference-list type.

​
config.allow_custom
boolean
default:"false"

Permit the user to create new options for this specific field.

​
config.sortBy
string
default:"label"

The field to sort the options by (label, value, ordinal)

​
config.options
required

An array of valid options the user can select from

​
value
required

The value or ID of this option. This value will be sent in egress

​
label
string
default:"value"

A visual label for this option, defaults to value if not provided

​
meta
object

An arbitrary JSON object to be associated with this option and made available to hooks

​
ordinal
number

The ordinal position of this option in the list. Only used if sortBy is set to ordinal. Options are sorted in ascending order.

{
  "key": "status",
  "label": "Status",
  "type": "enum",
  "config": {
    "options": [
      {
        "value": "active"
      },
      {
        "value": "inactive",
        "label": "Disabled",
        "meta": {
          "foo": "bar"
        }
      }
    ]
  }
},

​
enum-list

This feature requires Advanced Mapping.
For more information or to upgrade your plan, please reach out to Support.

Similar to enum type but allows multiple selections from the options list. The values are stored as an array.

{
  "key": "categories",
  "label": "Categories",
  "type": "enum-list",
  "config": {
    "options": [
      {
        "value": "electronics",
        "label": "Electronics"
      },
      {
        "value": "clothing",
        "label": "Clothing"
      }
    ]
  }
}

​
boolean

A true or false value type. Matching engines should attempt to resolve all common ways of representing this value and it should usually be displayed as a checkbox.

​
config.allowIndeterminate
boolean
default:"false"

Allow a neither true or false state to be stored as null.

{
  "key": "is_active",
  "label": "Active",
  "type": "boolean",
  "config": {
    "allowIndeterminate": true
  }
}

​
date

Store a field as a GMT date. Data hooks must convert this value into a YYYY-MM-DD format in order for it to be considered a valid value. Datetime is not currently available, but will be a separately supported Field Type in the future, and will include timezone.

{
  "key": "start_date",
  "label": "Start Date",
  "type": "date"
}
Suggest editsRaise issue