Skip to content

Properties

columnsobject[]

The field's columns. If present, the field's type is matrix

descriptionstring

The column's description

labelstring

The column's label

valuestring

The column's value

created_atstring · date-time

The date and time of the field's creation

descriptionstring

The field's description

field_groupobject

The field's group identifier. If present, the field is part of a group.

descriptionstring

The field group's description

idstring

The field groups's identifier

labelstring

The field group's label

namestring

The field groups's name

positionnumber

The index position of field group in the form.

formatstring

The format of the field.

Possible values:
urlemailpassword
idstring

The field's unique identifier

is_requiredboolean

Whether the field is required

labelstring

The field's label

namestring

The field's name. This is the name of the property in the entity.

optionsobject[]

The field's options

descriptionstring

The option's description

labelstring

The option's label

valuestring

The option's value

placeholderstring

The field's placeholder

positionnumber

The index position of field in the form.

rangeobject

The range applicable for field types number, rating, scale.

maxnumber

The maximum range for the field.

max_labelnumber

The label for the maximum range of the field.

minnumber

The minimum range for the field.

min_labelnumber

The label for the minimum range of the field.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

rowsobject[]

The field's rows. If present, the field's type is matrix

descriptionstring

The row's description

labelstring

The row's label

valuestring

The row's value

typestring

The field's type. If no clear mapping exists, then raw value is returned.

Possible values:
statementstringtextrich_textnumberbooleandatedatetimetimeenumarrayfile+ 7 more
updated_atstring · date-time

The date and time of the field's last update

validationstring

The validation string for the field.