Skip to content

Configuration Slugs (GraphQL)

Query field: listAdminConfigurationSlug.

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

Selection set

The query exposes one field, slugs — a JSON array. Select it bare; it is not a typed sub-object.

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.

Errors

CauseResponse
Unauthenticatederrors[] — admin Bearer token required.

Released under the MIT License.