Returns a list of all AdditionalUiField
Query parameters
-
deleted
boolean This property is used to mark an entity as deleted / archived | Requires access right: SCOPE | Default value: false
-
name
string Requires access right: SCOPE
-
entityType
string Requires access right: SCOPE
-
infoMode
string Requires access right: SCOPE
-
fieldGroup
string Requires access right: SCOPE
-
fieldType
string Requires access right: SCOPE
-
fieldName
string Requires access right: SCOPE
-
fieldOrder
string Requires access right: SCOPE
-
searchString
string text to search for in the list
-
orderFieldName
string name of the order field
-
orderFieldSort
string sorting mode
Values are
DESC
orASC
. -
page
integer page of the list
Default value is
0
. -
pageSize
integer number of entries for each page
Minimum value is
1
, maximum value is200
. Default value is50
. -
withMaxPageNumber
string returns the number of pages available as a header if this is set
-
iw-build-id
string build id of the client
-
iw-package-id
string package id of the client
GET
/api/settings/ui_field
curl \
--request GET 'https://replace-with-own-host.iw-erp.de/api/settings/ui_field' \
--header "x-session-token: $API_KEY"
Response examples (200)
[
{
"id": 42,
"entity_type": "string",
"field_type": "string",
"field_group": "string",
"field_required": true,
"field_order": 42,
"field_scope": "string",
"field_access_type": 42,
"field_is_internal": true,
"field_name": "string",
"info_mode": "string",
"created": "2025-05-04T09:42:00Z",
"updated": "2025-05-04T09:42:00Z",
"name": "string",
"deleted": true
}
]