Get Configurations

API operation: Open the endpoint in Scalar

Use GET /configs to list configurations visible to the caller. The operation is Config.findAll.

Default list response

Without mode, the operation returns result as an array. dictionary is not a runtime default.

{
  "error": false,
  "result": [
    {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  ]
}

Dictionary mode

Set mode=dictionary to return an object indexed by configuration key instead of an array:

GET /configs?mode=dictionary

{
  "error": false,
  "result": {
    "example_setting": {
      "id": 1,
      "key": "example_setting",
      "value": "example",
      "public": true,
      "hidden": false
    }
  }
}

Dictionary mode excludes v2-only configurations and omits description from model-backed entries. mode=dashboard is not an alias for dictionary mode.

Visibility and access

Callers without administrator or server access may see only configurations where public=true and hidden=false, subject to plugin and business-manager exceptions. Requests may use an API key or bearer token; do not assume anonymous access is enabled.

Protected configurations can return PROTECT instead of their stored value. Never use documentation examples to expose or infer protected values.

Legacy SDK example

const list = await ordering.configs().get()
const dictionary = await ordering.configs().asDictionary().get()

SDK helper names and arguments may differ by version.