Field Types

Each collection has a schema, which defines the fields that can be added to items in the collection. Each field has a type, which determines the data that can be stored in the field. To see a list of field types included in your collection, make a request to the Get Collection endpoint.

Plain Text

Basic text content that doesn’t need special formatting.

string

Rich Text

A long text field that can span multiple lines. Accepts HTML Formatting.

string

ImageRef / Image

The image field allows you to upload a single image for your Collection items and use it in your designs. Images must be hosted on a publicly accessible URL to be uploaded via the API. The maximum file size for images is 4MB.

You can also add an image that already exists in the CMS by referencing its fileId.

1
{
2
  fileId: string,
3
  url: string,
4
  alt?: string
5
}

ImageRefSet / Multi-Image

The multi-image field allows you to upload multiple images for a Collection item and use it in your designs. Images must be hosted on a publicly accessible URL to be uploaded via the API. The maximum file size for images is 4MB.

You can also add images that already exist in the CMS by referencing the fileId.

1
Array<{
2
  fileId: string,
3
  url: string,
4
  alt?: string
5
}>

VideoLink

Adds videos hosted on platforms such as YouTube or Vimeo through a URL. These are usually connected to a video element.

string

Link

Adds a generic link that can be connected to any link element such as a button, a text link, or a link block.

string

Email

Adds an email address field to collection items.

string

Phone

string

Number

Add any kind of number (integer, decimal) to your collection items.

number

DateTime

Add a date and time picker to your collection items.

string

Switch

A boolean field that allows you to toggle between true and false.

boolean

Color

Adds a unique color to each collection item which can be applied as text color, background color, and border color in your designs. Accepts a HEX code as a string.

string

Accepts the following formats

• #RGB
• #RGBA
• #RRGGBB
• #RRGGBBAA
• rgb(red,green,blue)
• rgba(red,green,blue,alpha)
• hsl(hue,saturation,lightness)
• hsla(hue,saturation,lightness,alpha)
• orchid, aqua, black, …
• transparent

Option

Creates a list of predefined values to choose from for each collection item. You can pass either the option_id or the string name of the option.

string

File

Adds a file to your collection items that you can connect to any link element in your project. Files must be hosted on a publicly accessible URL to be uploaded via the API.

1
{
2
fileId: string,
3
  url: string,
4
  alt?: string
5
}

ItemRef / Reference

Link to a collection item from the same or different collections.

When creating a reference field, get the collectionId of the collection you’re looking to reference. Then, when creating the field using the Create Field endpoint, pass the collectionId to the metadata property as "collectionId": <collectionId>.

string

Set / Multi-Reference

Link to multiple collection items from the same or different collections.

When creating a reference field, get the collectionId of the collection you’re looking to reference. Then, when creating the field using the Create Field endpoint, pass the collectionId to the metadata property as "collectionId": <collectionId>.

Array<string, string, string>

User

Unique User ID that is set by Webflow. Only used for created-by and updated-by fields.

string