Field
A Field belongs to a Form and describes one piece of data to collect. Fields specify the data type, whether the value is required, a fixed set of allowed options, and conditional dependency logic that controls visibility based on another field’s value. Fields can be created inline during form creation or managed independently through the field sub-resource endpoints.
Sample Object
{
"id": "fld_abc123def457",
"form_id": "frm_abc123def456",
"name": "country",
"data_type": "string",
"options": ["US", "CA", "UK", "DE", "JP"],
"required": true,
"depends_field": "",
"depends_field_value": ""
}Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the field. Auto-generated on creation. |
form_id | string | Identifier of the parent form this field belongs to. |
name | string | Field name. Used as the payload key when submitting entries. Required. |
data_type | string | Expected data type for the field value. Common values include string, int, text, email, boolean. Required. |
options | array of strings | Fixed set of allowed values for the field. When set, entry payloads are validated against this list. |
required | boolean | Whether the field must have a value in the entry payload. Required. |
depends_field | string | Name of another field that controls this field’s visibility. When set, this field is only required if the referenced field matches depends_field_value. |
depends_field_value | string | Value that the depends_field must equal for this field to be required. |
Actions
Creating a field on a form
Add a new field to an existing form. The field is appended to the form schema.
Field management is available through the SDK and REST API.
Deleting a field from a form
Remove a field from the form schema permanently.
Field management is available through the SDK and REST API.