Skip to content

Configuration Slugs

EndpointMethod
/api/admin/configuration/slugsGET

Lists every registered configuration slug (a section or group key) so you can discover the valid slugs to pass to the Values and Update endpoints — without trial and error. See the Configuration overview for how the endpoints fit together.

The response is a one-element array; the object inside carries slugs (the list).

Slug shape

Each entry in slugs[] carries:

KeyMeaning
slugDotted key (e.g. sales.order_settings). Pass this to Values / Update.
nameHuman-readable label (already translated).
sortDisplay order within its parent.
hasFieldstrue when the node holds editable fields directly.
hasChildrentrue when the node nests further sub-nodes.

A node where hasFields is true is the level you read values for; a node where only hasChildren is true is a parent you can drill into.

Response codes

CodeMeaning
200Slug list returned.
401Unauthenticated.

Released under the MIT License.