Skip to content

Configuration Menu (GraphQL)

Query field: menuAdminConfigurationMenu.

This is the discovery operation — it returns the configuration schema tree (Section → Group → Field group → Field). Call it first to learn which fields a section has, each field's dotted code (the key you read and write), its type, default, scoping flags, validation, and options. See the Configuration overview for how Menu, Values, and Update fit together.

Selection set

The query exposes two fields: slug (echoes the requested scope) and tree (the schema, a JSON array — select it bare; it is not a typed sub-object).

Arguments

ArgumentTypeNotes
slugStringOptional. Scopes the response to one node, e.g. sales.order_settings. Omit to return the whole tree.
include_valuesBooleanWhen true, embeds each field's current value (resolved with channel / locale).
channelStringChannel code used when resolving values. Defaults to the default channel.
localeStringLocale code used when resolving values. Defaults to the app locale.

Arguments are snake_case

The flag is include_values, not includeValues. All admin GraphQL query arguments use snake_case in this API.

Field shape

Each leaf field in tree[*]…fields[] carries:

KeyMeaning
nameShort field name within its group.
codeFully-qualified dotted path (e.g. sales.order_settings.reorder.admin). Use this to read / write.
titleHuman-readable label (already translated).
typetext, textarea, boolean, select, multiselect, password, image, file, or custom.
defaultDefault used when no value has been saved.
channelBased / localeBasedWhether the field is scoped per channel / per locale.
validationLaravel validation string applied on Update (server-enforced).
optionsFor select / multiselect — array of { title, value }.
depends, infoOptional UI hints.
customViewSet for type: "custom" (blade-rendered) fields. These are read-only via the API.
valueOnly present when include_values: true — the field's current value (a string, or null if unset).

Errors

CauseResponse
Unknown slugerrors[] — slug not registered.
Unauthenticatederrors[] — admin Bearer token required.

Released under the MIT License.