Skip to main content

Get Workspace Menu Override (v1)

Get workspace menu configuration.

Method & Path​

GET /v1/admin/workspace-menus/:workspaceId/menus

Description​

Retrieves the menu override configuration for a specific workspace, which controls which dashboard sections are visible to workspace users.

Authentication​

Required: Admin authentication with businesses.manage permission.

Path Parameters​

ParameterTypeRequiredDescription
workspaceIdstringYesThe workspace ID

Response 200 OK​

{
  "override": {
    "workspaceId": "507f1f77bcf86cd799439011",
    "allowedMenuSections": [
      "overview",
      "sessions",
      "clients",
      "settings"
    ]
  }
}

Common Errors​

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions
  • 404 Not Found: Workspace menu override not found
  • 500 Internal Server Error: Server error