Return single AdditionalUiField

GET /api/settings/ui_field/{identifier}

Session token Jwt token internal Login config

Path parameters

identifier string Required

Query parameters

iw-build-id string

build id of the client
iw-package-id string

package id of the client

Responses

200 application/json

Return single AdditionalUiField
Hide response attributes Show response attributes object
- id integer
- entity_type string
- field_type string
- field_group string
- field_required boolean
- field_order integer
- field_scope string
- field_access_type integer
- field_is_internal boolean
- field_name string
- info_mode string
- created string(date-time)
- updated string(date-time)
- name string
- deleted boolean

GET /api/settings/ui_field/{identifier}

curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/settings/ui_field/{identifier}' \
 --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
}