/
v3.0.11Get access

getMenus

Retrieve a list of menu items by menu type and platform

Request parameters:

NameDescriptionTypeValuesDefault
type
Menu type identifierstring"main", "footer", "sidebar"-
platform
Platform namestring"desktop" / "mobile"-

Call example:

getMenus({
  type: 'main',
  platform: 'desktop'
})

Response parameters:

NameDescriptionTypeValues
id
Auto-increment unique identifier of the menu itemnumber-
title
Display title of the menu itemstring-
type
Menu item type — "group" for a collapsible parent or "link" for a navigation itemstring-
value
URL or route value associated with the menu itemstring-
profile_types
List of restricted profile types. Empty array means no restrictionarray-
show_to
Visibility scope: 0 = all, 1 = authorized users only, 2 = guests onlynumber-
target
Link target attribute: "_blank", "_self", "_parent", or "_top"string-
icon
Icon string value, or null if not setstring | null-
badge
Badge object containing "title" and "class" fields, or null if not setobject | null-
badge.title
Display text of the badge (e.g. "new")string-
badge.class
CSS class applied to the badge (e.g. "new")string-
children
Nested child menu items. Only present on items with type "group"array-