Skip to content

Configuration Menu

EndpointMethod
/api/admin/configuration/menuGET

The discovery endpoint — 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.

The response is a one-element array; the object inside carries slug (the requested scope) and tree (the schema).

Query parameters

ParamTypeNotes
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.

Field shape

Each leaf field 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 — read-only via the API.
valueOnly present when include_values=true — the field's current value (a string, or null if unset).

Response codes

CodeMeaning
200Tree returned.
401Unauthenticated.
404Slug not registered.

Released under the MIT License.