Get Custom Menu Link

GET 
/custom-menus/:customMenuId

Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata

Request

Version stringrequired

API Version

Available optionsv3

customMenuId stringrequired

Unique identifier of the custom menu

application/json

Successfully retrieved custom menu. Returns a single custom menu object, potentially including its structure, items, and relevant metadata.

application/json

Schema

Schema

customMenuobject

Single Custom menu link object

Example (auto)

{
  "customMenu": {
    "id": "12345",
    "icon": {
      "name": "yin-yang",
      "fontFamily": "fab"
    },
    "title": "Dashboard",
    "url": "/dashboard",
    "order": 1,
    "showOnCompany": true,
    "showOnLocation": true,
    "showToAllLocations": true,
    "locations": [
      "gfWreTIHL8pDbggBb7af",
      "67WreTIHL8pDbggBb7ty"
    ],
    "openMode": "iframe",
    "userRole": "all",
    "allowCamera": false,
    "allowMicrophone": false
  }
}