AttributeFields
Introduction
AttributeFields define the input structure of an AttributeSet.
They use form_type + form_id to reference their container set and support field-specific configuration through config.
Rich-text values in default_value and type-specific config keys use the shared Rich Text HTML format. This applies to the rich-text and description type values and the privacy-policy type's config.text value.
Model Definition
Alias
formField
Capabilities
Translations - Localizes
name,default_value,placeholder, anddescription; examples useen-US.
Relations
User endpoints
List all fields
List visible AttributeFields.
Definition
GET /api/additional-attributes/fields
Example Request
Example Response
List fields by set
List visible AttributeFields for one AttributeSet.
Definition
GET /api/additional-attributes/sets/{formEntity}/fields
Route Parameters
formEntity
integer
AttributeSet ID.
Example Request
Example Response
Show field
Show one visible AttributeField.
Definition
GET /api/additional-attributes/fields/{formField}
Route Parameters
formField
integer
Field ID.
Example Request
Example Response
Entity-select endpoints
List preselected entities
List entities preselected for one AttributeField.
Definition
POST /api/additional-attributes/fields/{formField}/preselected-entities
Route Parameters
formField
integer
Entity-select field ID.
Request Keys
page
integer
1
Result page.
per_page
integer
Server default
Results per page.
filter
object
No filters
Additional value filters applied to the selected entities.
Behavior
Field 29 is configured as a user entity-select; its default_value contains user IDs 7 and 8, which produce the two preselected entities below.
Example Request
Example Response
List selectable entities
List entities selectable for one AttributeField.
Definition
POST /api/additional-attributes/fields/{formField}/selectable-entities
Route Parameters
formField
integer
Entity-select field ID.
Request Keys
page
integer
1
Result page.
per_page
integer
Server default
Results per page.
filter
object
No filters
Additional value filters; configured field filters take precedence.
Behavior
Field 29 uses entity_type: user. The request limits the page to the two users shown in the response.
Example Request
Example Response
List selectable-entity filters
List selectable-entity filters for one AttributeField.
Definition
POST /api/additional-attributes/fields/{formField}/selectable-entities/filters
Route Parameters
formField
integer
Entity-select field ID.
Request Keys
filter
object
No filters
Value filters used to calculate the available filter options.
Behavior
The response is derived from field 29's user entity type and its configured selectable-entity filters.
Example Request
Example Response
List selectable-entity filter options
List options for one selectable-entity filter of an AttributeField.
Definition
POST /api/additional-attributes/fields/{formField}/selectable-entities/{filterKey}/options
Route Parameters
formField
integer
Entity-select field ID.
filterKey
string
Multi-select filter key.
Request Keys
page
integer
1
Result page.
per_page
integer
Server default
Results per page.
filter
object
No filters
Value filters applied before option aggregation.
Example Request
Example Response
Administration endpoints
Admin: List preselected entities
List entities preselected for one AttributeField in administration scope.
Definition
POST /api/administration/additional-attributes/fields/{formField}/preselected-entities
Route Parameters
formField
integer
Entity-select field ID.
Request Keys
page
integer
1
Result page.
per_page
integer
Server default
Results per page.
filter
object
No filters
Additional value filters applied to the selected entities.
Behavior
Field 29 is configured as a user entity-select; its default_value contains user IDs 7 and 8, which produce the two preselected entities below.
Example Request
Example Response
Admin: List selectable entities
List entities selectable for one AttributeField in administration scope.
Definition
POST /api/administration/additional-attributes/fields/{formField}/selectable-entities
Route Parameters
formField
integer
Entity-select field ID.
Request Keys
page
integer
1
Result page.
per_page
integer
Server default
Results per page.
filter
object
No filters
Additional value filters; configured field filters take precedence.
Behavior
Field 29 uses entity_type: user. The request limits the page to the two users shown in the response.
Example Request
Example Response
Admin: List selectable-entity filters
List selectable-entity filters for one AttributeField in administration scope.
Definition
POST /api/administration/additional-attributes/fields/{formField}/selectable-entities/filters
Route Parameters
formField
integer
Entity-select field ID.
Request Keys
filter
object
No filters
Value filters used to calculate the available filter options.
Behavior
The response is derived from field 29's user entity type and its configured selectable-entity filters.
Example Request
Example Response
Admin: List selectable-entity filter options
List options for one selectable-entity filter of an AttributeField in administration scope.
Definition
POST /api/administration/additional-attributes/fields/{formField}/selectable-entities/{filterKey}/options
Route Parameters
formField
integer
Entity-select field ID.
filterKey
string
Multi-select filter key.
Request Keys
page
integer
1
Result page.
per_page
integer
Server default
Results per page.
filter
object
No filters
Value filters applied before option aggregation.
Example Request
Example Response
Admin: List all fields
List all AttributeFields in administration scope.
Definition
GET /api/administration/additional-attributes/fields
Example Request
Example Response
Admin: List fields by set
List all AttributeFields for one AttributeSet in administration scope.
Definition
GET /api/administration/additional-attributes/sets/{formEntity}/fields
Route Parameters
formEntity
integer
AttributeSet ID.
Example Request
Example Response
Admin: Show field
Show one AttributeField in administration scope.
Definition
GET /api/administration/additional-attributes/fields/{formField}
Route Parameters
formField
integer
Field ID.
Example Request
Example Response
Admin: Create field
Create a new AttributeField.
Definition
POST /api/administration/additional-attributes/fields
Request Keys
form_type*
string
-
Morph alias of container entity. For attribute fields use attributeSet.
lang_id
string
system language
Language key for translated values.
name*
string
-
Field label shown to users.
slug
string
derived from name
Technical slug. Sanitized automatically.
default_value
mixed
null
Static default value.
placeholder
string
null
Placeholder text.
description
string
null
Field description/help text.
hidden
boolean
false
Hide field in UI.
disabled
boolean
false
Disable field input.
config
object
type defaults
Type-specific configuration object.
Keys with * are required.
Example Request
Example Response
Admin: Update field
Update an existing AttributeField.
Definition
PUT /api/administration/additional-attributes/fields/{formField}
Route Parameters
formField
integer
ID of the field to update.
Request Keys
form_field_type_id
string
New field type key.
lang_id
string
New language key.
name
string
New field label.
slug
string
New technical slug.
default_value
mixed
New static default value.
placeholder
string
New placeholder text.
description
string
New help text.
hidden
boolean
Update hidden state.
disabled
boolean
Update disabled state.
config
object
Updated type-specific configuration.
Example Request
Example Response
Admin: Delete field
Delete an existing AttributeField.
Definition
DELETE /api/administration/additional-attributes/fields/{formField}
Route Parameters
formField
integer
Field ID.
Example Request
Example Response
The field administration endpoints are complemented by AttributeFieldDefaultValueSources, AttributeFieldValidations, and AttributeFieldDisplayConditions.
Last updated