Menu
Tags: customization, navigation, workspace
Endpoints
GET /{site_id}/menu- MenuGET /{site_id}/menu/items- ItemsPOST /{site_id}/menu/items- ItemsDELETE /{site_id}/menu/items/{item_id}- Delete ItemsPUT /{site_id}/menu/items/{item_id}- Update ItemsPOST /{site_id}/menu/reorder- Reorder
Menu
GET /api/v2/w/{workspace_uuid}/menu/{site_id}/menu
Description:
Workspace menu customization and navigation
Get the complete menu tree for a site, with optional locale for translated labels.
Authorization: Requires sites:read scope
Parameters:
site_id(Integer)locale(String)
Response: See MenuTreeResponse
Items
GET /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items
Description:
Workspace menu customization and navigation
Get all menu items for a site, optionally filtered by parent.
Authorization: Requires sites:read scope
Parameters:
site_id(Integer)parent_id(Integer)
Response: List of MenuItemResponse
Items
POST /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items
Description:
Workspace menu customization and navigation
Create a new menu item.
Authorization: Requires sites:write scope
Parameters:
site_id(Integer)request- See CreateMenuItemRequest
Response: See MenuItemResponse
Delete Items
DELETE /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items/{item_id}
Description:
Workspace menu customization and navigation
Delete a menu item and all its children.
Authorization: Requires sites:admin scope
Parameters:
site_id(Integer)item_id(Integer)
Response: See dict
Update Items
PUT /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/items/{item_id}
Description:
Workspace menu customization and navigation
Update an existing menu item.
Authorization: Requires sites:write scope
Parameters:
site_id(Integer)item_id(Integer)request- See UpdateMenuItemRequest
Response: See MenuItemResponse
Reorder
POST /api/v2/w/{workspace_uuid}/menu/{site_id}/menu/reorder
Description:
Workspace menu customization and navigation
Reorder menu items within the same parent.
Authorization: Requires sites:write scope
Parameters:
site_id(Integer)request- See ReorderMenuItemsRequest
Response: See dict