Forms Object

---

id

string

The unique identifier of the form.

name

string

The name of the form.

type

string

The type of the form.

fields

object[]

The form fields

id

string

The field's unique identifier

name

string

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

label

string

The field's label

placeholder

string

The field's placeholder

description

string

The field's description

position

number

The index position of field in the form.

type

string

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

All possible enum values:

• statement
• string
• text
• rich_text
• number
• boolean
• date
• datetime
• time
• enum
• array
• file
• rating
• slider
• ranking
• group
• matrix

format

string

The format of the field.

All possible enum values:

• url
• email
• password

validation

string

The validation string for the field.

range

object

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

min

number

The minimum range for the field.

min_label

number

The label for the minimum range of the field.

max

number

The maximum range for the field.

max_label

number

The label for the maximum range of the field.

is_required

boolean

Whether the field is required

options

object[]

The field's options

label

string

The option's label

value

string

The option's value

description

string

The option's description

field_group

object

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

id

string

The field groups's identifier

name

string

The field groups's name

label

string

The field groups's label

rows

object[]

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

label

string

The row's label

value

string

The row's value

description

string

The row's description

columns

object[]

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

label

string

The column's label

value

string

The column's value

description

string

The column's description

options

object[]

The field's options

label

string

The option's label

value

string

The option's value

description

string

The option's description

workspace

object

The workspace to which the form belongs.

id

string

The unique identifier of the workspace.

name

string

The name of the workspace.

organization

object

The organization to which the workspace belongs.

id

string

The unique identifier of the organization.

name

string

The name of the organization.

last_submitted_at

string · date-time

The date and time when the form was last submitted.

created_at

string · date-time

The date and time when the form was created.

updated_at

string · date-time

The date and time when the form was last updated.

remote_data

object

Raw data returned from the remote API call.