Skip to content
Guides
Content & StorefrontMenus

Get active menu by key

Returns one menu by its key, with its items in order.

GET/v1/menus/{key}

Returns one menu by its key, with its items in order.

Path Parameters

key*string

Header Parameters

x-Store-Domain*string

Store slug or configured domain that selects the store context at the central Storefront gateway.

Length1 <= length <= 253

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/menus/example" \  -H "x-Store-Domain: my-store"
{  "key": "example",  "name": "Example resource",  "items": [    {      "label": "example",      "url": "https://example.com/resource",      "order": 1,      "target": "example",      "visible": false,      "children": []    }  ]}