Skip to main content
GET
/
cabinet
/
admin
/
settings
List Settings
curl --request GET \
  --url http://localhost:8080/cabinet/admin/settings
[
  {
    "key": "<string>",
    "name": "<string>",
    "category": {
      "key": "<string>",
      "label": "<string>"
    },
    "type": "<string>",
    "is_optional": true,
    "has_override": true,
    "current": "<unknown>",
    "original": "<unknown>",
    "read_only": false,
    "choices": [
      {
        "value": "<unknown>",
        "label": "<string>",
        "description": "<string>"
      }
    ],
    "hint": {
      "description": "",
      "format": "",
      "example": "",
      "warning": ""
    }
  }
]

Query Parameters

category_key
string | null

Response

Successful Response

key
string
required
name
string
required
category
SettingCategoryRef · object
required

Reference to category.

type
string
required
is_optional
boolean
required
has_override
boolean
required
current
any
original
any
read_only
boolean
default:false
choices
SettingChoice · object[]
hint
SettingHint · object

Setting hints and guidance.