Skip to content

Configuration Values

EndpointMethod
/api/admin/configuration?slug=<…>GET

Returns the flat code → value map of effective values for every field under the given slug. A field with no saved value falls back to the schema default reported by the Menu endpoint. See the Configuration overview for the full read → write flow.

The response is a one-element array; the object inside carries slug, channel, locale, and the values map.

Query parameters

ParamTypeNotes
slugstringRequired. The section.group (or deeper) scope to read, e.g. sales.order_settings.
channelstringChannel code for resolution. Defaults to the requested channel.
localestringLocale code for resolution. Defaults to the requested locale.

Response shape

values is a string → string map — the underlying store column is text, so booleans, numbers, and JSON all come back as strings ("1", "0", "49.99"). image / file fields return the storage path written by Update.

Response codes

CodeMeaning
200Values returned.
401Unauthenticated.
404Slug not registered.
422slug query parameter missing.

slug is required

The slug parameter is mandatory — it prevents accidentally dumping the entire configuration store in one call.

Scope is per-field

Whether channel / locale change the result depends on each field's channelBased / localeBased flags (see Menu). A global field returns the same value regardless of the channel / locale you pass.

Released under the MIT License.