Developers
Menus

List menus

GET/menus

Returns the fixed set of menus provided by the platform, including the capabilities and supported item kinds of each menu. Menus cannot be created or deleted.

Reading menus requires the menu_items.read permission; there is no separate permission for menus.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/menus"
{  "data": [    {      "item_kinds": [        "shortcut"      ],      "key": "student-area",      "label": "string",      "object": "menu",      "sidebar_hidden": true,      "supports_hierarchy": false,      "supports_move": false    }  ]}

Menus

Menus in API v3: list menus, retrieve a menu, list menu items, create a menu item, reorder menu items, retrieve a menu item, update a menu item, delete a menu item.

Retrieve a menu GET

Retrieves a menu from the fixed set of menus provided by the platform. The `sidebar_hidden` field reflects the current account's setting for hiding the sidebar menu.