List Settings

Get list of all settings or settings for a specific category.

GET /cabinet/admin/settings

List Settings

cURL

curl --request GET \
  --url https://api.example.com/cabinet/admin/settings \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "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": ""
    }
  }
]

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

category_key · string | null

Response

200

application/json

Successful Response

key · string · required

name · string · required

category · SettingCategoryRef · object · required

Reference to category.

Show child attributes

type · string · required

is_optional · boolean · required

has_override · boolean · required

current · any

original · any

read_only · boolean · default: false

choices · SettingChoice · object[]

Show child attributes

hint · SettingHint · object

Setting hints and guidance.

Show child attributes