- Home
- Models
- Field
Field
This represents each field within a form, and also each field related to a contact.
Field fields
Field |
Type |
Fillable |
Reference |
id
|
Integer
|
|
|
The unique ID to identify the field
|
Field relations
account,
child,
children,
conditions,
dependant_conditions,
form,
organisation,
integration_fields,
option,
parent,
organisation_type,
Field endpoints
GET List all Fields /fields toggle
Paramaters
- field_type
-
Field
The type of field you want to return either form, or contact
Required
Example response
GET Return data for a specified Field /fields/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the field
Paramaters
There are no parameters for this endpoint
Example response
POST Save, or update a Field /fields/:id? toggle
URL slugs
- id
-
Integer
The unique ID to identify the field
Paramaters
- conditions_requirement
-
String
Controls which field conditions must be met, either ANY or ALL
- contact_field_id
-
Reference
Nullable
References field model.
- contact_list_view
-
Integer
Nullable
The fields position in the contact field list view, 1-6
- field_type
-
String
[No documentation available]
Required
- form_id
-
Reference
Nullable
References form model.
- help_text
-
String
Nullable
Text that is displayed alongside the label
- hidden
-
Boolean
Nullable
Should this field be hidden
- label
-
String
The label of the field
- matchable
-
Integer
Nullable
- max_length
-
String
[No documentation available]
- min_length
-
String
[No documentation available]
- option_id
-
Reference
Nullable
References option model.
- order
-
Integer
Nullable
A numeric order to display fields in
- organisation_list_view
-
Integer
Nullable
The fields position in the organisation field list view, 1-6
- organisation_type_id
-
Reference
Nullable
References organisationtype model.
- page_id
-
Reference
References page model.
- parent_id
-
Reference
Nullable
References field model.
- placeholder
-
String
[No documentation available]
- portal_show
-
Integer
Nullable
- publication_id
-
Reference
Nullable
References publication model.
- required
-
Boolean
Nullable
Is this field required
- settings
-
String
Nullable
A JSON object of any additional settings
- sub_fields
-
String
Nullable
A JSON array of objects of sub fields used for repeatable field type
- tag
-
String
Nullable
The tag that can be used within templates
- type
-
Field
The field type
Required
- value
-
String
Nullable
A default value for this field
- values
-
JSON
Nullable
A JSON array of objects with value key
DELETE Delete a Field /fields/:id toggle
URL slugs
- id
-
Integer
The unique ID to identify the field
Paramaters
There are no parameters for this endpoint